Per interrompere le registrazioni pubbliche su un homeserver Matrix self-hosted con Synapse, imposta enable_registration: falsee homeserver.yamlriavvia Synapse. Se desideri che le persone invitate creino autonomamente i propri account, lascia la registrazione abilitata ma richiedi i token di registrazione. Verifica l' registration_shared_secretimpostazione separata: chiunque la conosca può comunque creare account, inclusi gli amministratori del server, anche quando la registrazione ordinaria è disabilitata.
Scegli la politica di registrazione più adatta
L'impostazione corretta dipende da come devono essere creati i nuovi account:
- Server privato, account gestiti da un amministratore: disabilitare la registrazione pubblica. Creare gli utenti tramite
register_new_matrix_useril comando di Synapse o un'altra procedura amministrativa approvata.
- Server ad accesso solo su invito, gli utenti si registrano da Element o da un altro client: abilitare la registrazione e richiedere un token. Fornire a ciascun utente un token a utilizzo limitato tramite un canale privato.
- Server pubblico: i token di registrazione, i CAPTCHA o la verifica dell'indirizzo email/telefono possono ridurre gli abusi automatizzati, ma non garantiscono che ogni account sia affidabile.
Questo articolo tratta Synapse, l'implementazione di homeserver Matrix self-hosted più diffusa. Altri software per homeserver hanno configurazioni diverse. La documentazione di configurazione attuale di Synapse indica che la registrazione è disabilitata per impostazione predefinita e che i token di registrazione funzionano solo quando la registrazione stessa è abilitata. Se si utilizza Matrix Authentication Service (MAS), consultare la relativa documentazione per i controlli di registrazione corrispondenti; l'API di amministrazione dei token di registrazione di Synapse è disabilitata quando l'integrazione con MAS è abilitata.
Disabilitare la registrazione pubblica su Synapse
- Individua il file di configurazione attivo. Le installazioni di pacchetti comuni utilizzano
/etc/matrix-synapse/homeserver.yaml; le installazioni di container spesso montano il file in /data/homeserver.yaml. Utilizza il percorso configurato per il tuo servizio anziché presumere una posizione specifica.
- Eseguire il backup del file, quindi impostare il flag di registrazione. Nella configurazione YAML di livello superiore, aggiungere o modificare l'impostazione come segue:
enable_registration: false
Se la chiave esiste già, modifica quella voce anziché aggiungerne una duplicata. L'indentazione YAML e le chiavi duplicate possono generare confusione, quindi mantieni l'impostazione al livello superiore e preserva la struttura esistente del file.
- Esaminate il segreto di registrazione condiviso. Synapse
registration_shared_secret(o registration_shared_secret_path) supporta lo script di registrazione amministrativa. La guida all'installazione di Synapse avverte che chiunque sia in possesso di questo segreto può creare account standard o amministrativi anche quando la registrazione pubblica è disattivata. Mantenetelo privato, limitate l'accesso al suo file e non inseritelo in un repository pubblico, nella configurazione del client o in un messaggio agli invitati. Se non utilizzate la registrazione tramite segreto condiviso, rimuovete l'impostazione solo dopo aver verificato che nessuna automazione dipenda da essa. In alternativa, potete creare account utilizzando un altro flusso di lavoro amministrativo supportato.
- Convalida e riavvia Synapse. Utilizza il gestore dei servizi, l'orchestrazione dei container o il metodo di distribuzione che esegue il tuo server. Per un servizio systemd comunemente denominato
matrix-synapse, un amministratore potrebbe eseguire:
sudo systemctl restart matrix-synapse
sudo systemctl status matrix-synapse --no-pager
Il nome esatto del servizio varia a seconda del pacchetto o del container di distribuzione. Controlla i log se il servizio non si avvia; non continuare a modificare ripetutamente un file di configurazione senza risolvere l'errore YAML o di configurazione segnalato.
Disabilitando la registrazione, gli account e l'accesso alle stanze esistenti non vengono rimossi. L'impostazione impedisce nuove registrazioni regolari tramite il flusso di registrazione del cliente; non si tratta di un controllo per la cancellazione dell'utente o la disattivazione del server.
Consenti le registrazioni solo tramite token di registrazione
Utilizza questa opzione quando desideri che gli invitati completino la registrazione autonomamente, ma non vuoi che venga visualizzata una pagina di registrazione pubblica. In homeserver.yaml, configura entrambe le impostazioni:
enable_registration: true
registration_requires_token: true
Riavvia Synapse dopo aver salvato. Un sistema di token gate non equivale a disabilitare la registrazione: chi possiede token validi può creare un account. Il manuale di configurazione di Synapse raccomanda di implementare controlli anti-abuso quando la registrazione è abilitata; scegli una policy appropriata al tuo pubblico e alla tua capacità operativa.
Per le versioni di Synapse che supportano l'API di amministrazione dei token di registrazione documentata, un amministratore può creare un token monouso. L'esempio seguente utilizza un URL segnaposto e un token di accesso; eseguirlo solo da un ambiente amministrativo attendibile, sostituire l'URL di base pubblico del server domestico e il token di accesso dell'amministratore e proteggere la cronologia e i log della shell:
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}'
La risposta include il token generato. Condividi privatamente tale valore con l'utente previsto. L'API di Synapse supporta anche un tempo di scadenza, misurato in millisecondi dall'epoca Unix; utilizza la documentazione ufficiale dell'API per calcolare e impostare correttamente la scadenza per la tua implementazione. Un token con un limite di utilizzo o una scadenza omessi avrà un utilizzo illimitato e nessuna scadenza, quindi imposta i limiti con attenzione. Gli amministratori possono elencare, aggiornare o eliminare i token tramite la stessa API. Non incollare un token bearer o un token di registrazione effettivo in un problema o articolo pubblico.
La gestione dei token è soggetta a limitazioni di versione e di implementazione: consultare la documentazione dell'API di amministrazione corrispondente alla versione di Synapse installata. La documentazione attuale indica che questa API di Synapse non è disponibile quando l'integrazione con MAS è abilitata; in tal caso, utilizzare l'API di amministrazione o la CLI di MAS.
Errori di configurazione comuni
- Modifica del file sbagliato: i container potrebbero leggere un file montato, mentre l'host ne possiede una copia separata. Verificare il percorso utilizzato dal processo Synapse in esecuzione.
- Dimenticate il riavvio: le modifiche alla configurazione vengono lette dal servizio, quindi una semplice modifica del testo non dimostra che la nuova policy sia attiva.
- Supponendo che la registrazione disabilitata blocchi ogni percorso: un segreto condiviso configurato rimane un percorso per la creazione dell'account. Proteggerlo o rimuoverlo a seconda che sia necessario per l'automazione amministrativa.
- Abilitare i token ma disabilitare la registrazione:
registration_requires_token non attiva automaticamente la registrazione. Entrambi i flag devono consentire il flusso previsto.
- Partendo dal presupposto che i token accessibili solo su invito impediscano qualsiasi abuso: un token riutilizzabile trapelato può essere utilizzato da persone non autorizzate. Limitate gli utilizzi, impostate una data di scadenza laddove possibile e distribuite i token privatamente.
Verifica il risultato
Dopo il riavvio di Synapse, apri il flusso di registrazione del tuo homeserver in un client Matrix utilizzando una sessione senza connessione. Per un server chiuso, il client non dovrebbe offrire una registrazione pubblica valida, mentre gli utenti esistenti dovrebbero comunque essere in grado di accedere. Per la registrazione con token, prova il flusso senza token e verifica che ne richieda uno; quindi utilizza un token di prova in un account di test controllato e verifica che la registrazione abbia successo. Controlla i log di Synapse e lo stato del token dell'API di amministrazione se il risultato differisce dalla policy che avevi previsto. Evita di eseguire test con il token di invito reale se ciò consumasse l'unico utilizzo consentito.
Riferimenti ufficiali