Aby zatrzymać publiczne rejestracje na samodzielnie hostowanym serwerze domowym Matrix z systemem Synapse, skonfiguruj enable_registration: falsei homeserver.yamluruchom ponownie Synapse. Jeśli chcesz, aby zaproszeni użytkownicy sami zakładali konta, pozostaw rejestrację włączoną, ale zamiast tego wymagaj tokenów rejestracyjnych. Sprawdź osobne registration_shared_secretustawienie: każdy, kto je zna, nadal może zakładać konta, w tym administratorzy serwera, nawet gdy zwykła rejestracja jest wyłączona.
Wybierz odpowiednią politykę rejestracji
Właściwe ustawienie zależy od sposobu tworzenia nowych kont:
- Serwer prywatny, konta utworzone przez administratora: wyłącz rejestrację publiczną. Twórz użytkowników za pomocą polecenia Synapse
register_new_matrix_userlub innego zatwierdzonego procesu administracyjnego.
- Serwer tylko na zaproszenie, użytkownicy rejestrują się z Element lub innego klienta: włącz rejestrację i wymagaj tokena. Przekaż każdej osobie token o ograniczonym czasie użytkowania za pośrednictwem kanału prywatnego.
- Serwer publiczny: tokeny rejestracyjne, CAPTCHA lub zweryfikowany adres e-mail/telefon mogą ograniczyć ryzyko zautomatyzowanych nadużyć, jednak nie gwarantują, że każde konto jest wiarygodne.
W tym artykule omówiono Synapse, najszerzej wdrażaną implementację serwera domowego Matrix hostowanego samodzielnie. Inne oprogramowanie serwera domowego ma własną konfigurację. Aktualna dokumentacja konfiguracji Synapse podaje, że rejestracja jest domyślnie wyłączona, a tokeny rejestracyjne działają tylko wtedy, gdy sama rejestracja jest włączona. Jeśli korzystasz z usługi uwierzytelniania Matrix (MAS), sprawdź jej dokumentację pod kątem odpowiednich opcji rejestracji; interfejs API administratora tokenów rejestracyjnych Synapse jest wyłączony po włączeniu integracji MAS.
Wyłącz rejestrację publiczną w Synapse
- Znajdź aktywny plik konfiguracyjny. Typowe instalacje pakietów używają
/etc/matrix-synapse/homeserver.yaml; instalacje kontenerów często montują plik w /data/homeserver.yaml. Użyj ścieżki skonfigurowanej dla swojej usługi, zamiast zakładać jedną lokalizację.
- Utwórz kopię zapasową pliku, a następnie ustaw flagę rejestracji. W konfiguracji YAML najwyższego poziomu dodaj lub zmień ustawienie na:
enable_registration: false
Jeśli klucz już istnieje, edytuj ten wpis zamiast dodawać duplikat. Wcięcia w YAML i duplikaty kluczy mogą powodować zamieszanie, dlatego należy zachować ustawienie na najwyższym poziomie i zachować istniejącą strukturę pliku.
- Sprawdź współdzielony klucz tajny rejestracji. Synapse
registration_shared_secret(lub registration_shared_secret_path) obsługuje skrypt rejestracji administracyjnej. Przewodnik instalacji Synapse ostrzega, że osoba znająca ten klucz tajny może tworzyć konta standardowe lub administracyjne, nawet gdy rejestracja publiczna jest wyłączona. Zachowaj go w tajemnicy, ogranicz dostęp do jego pliku i nie umieszczaj go w publicznym repozytorium, konfiguracji klienta ani wiadomości dla zaproszonych osób. Jeśli nie korzystasz z rejestracji z współdzielonym kluczem tajnym, usuń to ustawienie dopiero po potwierdzeniu, że żadna automatyzacja od niego nie zależy. Zamiast tego możesz utworzyć konta, korzystając z innego obsługiwanego przepływu pracy administratora.
- Sprawdź poprawność i uruchom ponownie Synapse. Użyj menedżera usług, orkiestracji kontenerów lub metody wdrażania, która obsługuje Twój serwer. W przypadku usługi systemd, powszechnie nazywanej
matrix-synapse, administrator może uruchomić:
sudo systemctl restart matrix-synapse
sudo systemctl status matrix-synapse --no-pager
Dokładna nazwa usługi różni się w zależności od wdrożeń pakietów i kontenerów. Sprawdź dzienniki, jeśli usługa nie uruchamia się; nie edytuj wielokrotnie pliku konfiguracyjnego bez rozwiązania zgłoszonego błędu YAML lub konfiguracji.
Istniejące konta i dostęp do pokoi nie są usuwane przez wyłączenie rejestracji. To ustawienie uniemożliwia nowe, regularne rejestracje w procesie rejestracji klienta; nie jest to kontrola usuwania użytkowników ani dezaktywacji serwera.
Zezwalaj na rejestrację tylko za pomocą tokenów rejestracyjnych
Użyj tej opcji, jeśli chcesz, aby zaproszeni goście sami dokończyli rejestrację, ale nie chcesz, aby strona rejestracji była otwarta. W homeserver.yamlskonfiguruj oba ustawienia:
enable_registration: true
registration_requires_token: true
Po zapisaniu uruchom ponownie Synapse. Bramka tokenów to nie to samo, co wyłączenie rejestracji: osoby z ważnymi tokenami mogą tworzyć konta. Podręcznik konfiguracji Synapse zaleca stosowanie kontroli antynadużyciowych po włączeniu rejestracji; wybierz politykę odpowiednią do odbiorców i możliwości operacyjnych.
W wersjach Synapse obsługujących udokumentowany interfejs API administratora tokenów rejestracyjnych (Registration Tokens Admin API), administrator może utworzyć token jednorazowego użytku. Poniższy przykład wykorzystuje zastępczy adres URL i token dostępu; należy go uruchomić tylko z zaufanego środowiska administracyjnego, zastąpić go publicznym, bazowym adresem URL serwera domowego i tokenem dostępu administratora oraz zabezpieczyć historię i logi powłoki:
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}'
Odpowiedź zawiera wygenerowany token. Udostępnij tę wartość prywatnie wybranemu użytkownikowi. API Synapse obsługuje również czas wygaśnięcia mierzony w milisekundach od epoki Unix; skorzystaj z oficjalnego odwołania do API, aby poprawnie obliczyć i ustawić czas wygaśnięcia dla swojego wdrożenia. Token z pominiętym limitem użycia lub datą wygaśnięcia domyślnie ma nieograniczoną liczbę użyć i nie ma daty wygaśnięcia, dlatego należy celowo ustawić limity. Administratorzy mogą wyświetlać, aktualizować lub usuwać tokeny za pośrednictwem tego samego API. Nie wklejaj rzeczywistego tokena okaziciela ani tokena rejestracyjnego do publicznego zgłoszenia lub artykułu.
Zarządzanie tokenami ma ograniczenia wersji i wdrożenia: zapoznaj się z dokumentacją API administratora odpowiadającą zainstalowanej wersji Synapse. Aktualna dokumentacja informuje, że to API Synapse jest niedostępne po włączeniu integracji MAS; w takiej konfiguracji należy użyć API administratora MAS lub interfejsu wiersza poleceń.
Typowe błędy konfiguracji
- Zmiana niewłaściwego pliku: kontenery mogą odczytywać zamontowany plik, podczas gdy host ma jego osobną kopię. Sprawdź ścieżkę używaną przez uruchomiony proces Synapse.
- Zapomnienie o ponownym uruchomieniu: zmiany konfiguracji są odczytywane przez usługę, więc sama pomyślna edycja tekstu nie jest dowodem na to, że nowa polityka jest aktywna.
- Zakładając, że wyłączona rejestracja blokuje każdą ścieżkę: skonfigurowany współdzielony sekret pozostaje ścieżką tworzenia konta. Zabezpiecz go lub usuń w zależności od tego, czy automatyzacja administracyjna tego wymaga.
- Włączenie tokenów, ale wyłączenie rejestracji:
registration_requires_token nie powoduje niezależnego włączenia rejestracji. Obie flagi muszą zezwalać na zamierzony przepływ.
- Zakładając, że tokeny dostępne tylko na zaproszenie zapobiegają wszelkim nadużyciom: wyciekły token wielokrotnego użytku może zostać wykorzystany przez osoby nieupoważnione. Ogranicz użycie, ustaw termin ważności tam, gdzie to możliwe, i rozprowadzaj tokeny prywatnie.
Sprawdź wynik
Po ponownym uruchomieniu Synapse otwórz przepływ rejestracji serwera domowego w kliencie Matrix, korzystając z sesji bez logowania. W przypadku serwera zamkniętego klient nie powinien oferować pomyślnej rejestracji publicznej, podczas gdy istniejący użytkownicy powinni nadal mieć możliwość logowania. W przypadku rejestracji z bramką tokenową wypróbuj przepływ bez tokena i upewnij się, że jest on wymagany; następnie użyj tokena testowego na kontrolowanym koncie testowym i potwierdź, że rejestracja się powiodła. Sprawdź logi Synapse i status tokena w interfejsie API administratora, jeśli wynik różni się od zamierzonego. Unikaj testowania z użyciem prawdziwego tokena zaproszenia, jeśli spowodowałoby to zużycie jego jedynego dozwolonego zakresu.
Oficjalne źródła