SynapseでMatrixサインアップを閉鎖するか、招待トークンを必須にする

Synapse を実行している自己ホスト型 Matrix ホームサーバーで一般ユーザーによるサインアップを停止するには、設定をenable_registration: false変更しhomeserver.yamlて Synapse を再起動します。招待されたユーザーが自分でアカウントを作成できるようにするには、登録を有効にしたまま、代わりに登録トークンを要求するように設定します。別のregistration_shared_secret設定を確認してください。通常の登録が無効になっている場合でも、サーバー管理者を含め、この設定を知っているユーザーはアカウントを作成できます。

適切な登録ポリシーを選択してください

適切な設定は、新規アカウントの作成方法によって異なります。

  • プライベートサーバー、管理者がプロビジョニングしたアカウント:公開登録を無効にします。Synapseのregister_new_matrix_userコマンド、または承認された別の管理プロセスを使用してユーザーを作成します。
  • 招待制サーバー。ユーザーはElementまたは他のクライアントから登録する。登録を有効にし、トークンを要求する。各ユーザーにプライベートチャネルを通じて使用回数制限付きのトークンを付与する。
  • 公開サーバーの場合、登録トークン、CAPTCHA、または認証済みのメールアドレス/電話番号は自動化された不正利用を減らすことができますが、すべてのアカウントが信頼できることを保証するものではありません。

この記事では、最も広く普及しているセルフホスト型Matrixホームサーバー実装であるSynapseについて説明します。他のホームサーバーソフトウェアにはそれぞれ独自の構成があります。Synapseの現在の構成ドキュメントによると、登録はデフォルトで無効になっており、登録トークンは登録自体が有効になっている場合にのみ機能します。Matrix Authentication Service(MAS)を使用する場合は、対応する登録制御についてMASのドキュメントを確認してください。MAS統合が有効になっている場合、Synapseの登録トークン管理APIは無効になります。

Synapseでの公開登録を無効にする

  1. アクティブな設定ファイルを見つけてください。一般的なパッケージのインストールでは を使用します/etc/matrix-synapse/homeserver.yamlが、コンテナのインストールでは の下にマウントされることがよくあります/data/homeserver.yaml。特定の場所を想定するのではなく、サービス用に設定されたパスを使用してください。
  2. ファイルをバックアップしてから、登録フラグを設定します。最上位のYAML設定で、設定を追加または変更します。
    enable_registration: false
    キーが既に存在する場合は、重複するエントリを追加するのではなく、既存のエントリを編集してください。YAMLのインデントと重複するキーは混乱を招く可能性があるため、設定は最上位レベルに配置し、ファイルの既存の構造を維持してください。
  3. 共有登録シークレットを確認してください。Synapseのregistration_shared_secret(またはregistration_shared_secret_path) は、管理者登録スクリプトをサポートしています。Synapse のインストール ガイドでは、このシークレットを知っているユーザーは、公開登録が無効になっている場合でも、標準アカウントまたは管理者アカウントを作成できると警告しています。このシークレットは非公開にし、ファイルへのアクセスを制限し、公開リポジトリ、クライアント構成、または招待者へのメッセージに含めないでください。共有シークレット登録を使用しない場合は、自動化がそれに依存していないことを確認してから設定を削除してください。代わりに、サポートされている別の管理者ワークフローを使用してアカウントを作成できます。
  4. Synapse を検証して再起動します。サーバーを実行しているサービスマネージャ、コンテナオーケストレーション、またはデプロイ方法を使用します。一般的に という名前の systemd サービスの場合matrix-synapse、管理者は次のように実行できます。
    sudo systemctl restart matrix-synapse
    sudo systemctl status matrix-synapse --no-pager
    パッケージやコンテナのデプロイ方法によって、サービス名が異なる場合があります。サービスの起動に失敗した場合はログを確認してください。報告されたYAMLエラーや設定エラーを解決せずに、設定ファイルを繰り返し編集しないでください。

登録を無効にしても、既存のアカウントやルームへのアクセス権は削除されません。この設定は、クライアント登録フローを通じた新規の通常登録を防止するものであり、ユーザーの削除やサーバーの無効化を制御するものではありません。

登録トークンを使用したサインアップのみを許可する

招待者に自分でサインアップを完了させたいが、登録ページを公開したくない場合は、このオプションを使用してください。 でhomeserver.yaml、両方の設定を構成します。

enable_registration: true
registration_requires_token: true

保存後、Synapseを再起動してください。トークンゲートは登録を無効にすることとは異なります。有効なトークンを持つユーザーはアカウントを作成できます。Synapseの設定マニュアルでは、登録を有効にする場合は不正利用防止対策を講じることを推奨しています。対象ユーザーと運用能力に適したポリシーを選択してください。

ドキュメントに記載されている登録トークン管理APIをサポートするSynapseバージョンでは、管理者は使い捨てトークンを作成できます。以下の例ではプレースホルダーURLとアクセストークンを使用しています。信頼できる管理環境からのみ実行し、ホームサーバーの公開ベースURLと管理者アクセストークンに置き換え、シェル履歴とログを保護してください。

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}'

レスポンスには生成されたトークンが含まれます。その値を意図したユーザーと非公開で共有してください。SynapseのAPIは、Unixエポックからのミリ秒単位で測定される有効期限もサポートしています。公式APIリファレンスを使用して、デプロイメントに合わせて有効期限を正しく計算および設定してください。使用制限または有効期限が省略されたトークンは、デフォルトで無制限の使用と有効期限なしとなるため、制限は意図的に設定してください。管理者は、同じAPIを使用してトークンを一覧表示、更新、または削除できます。実際のベアラートークンまたは登録トークンを公開の問題や記事に貼り付けないでください。

トークン管理にはバージョンとデプロイメントの境界があります。インストールされているSynapseリリースに対応するAdmin APIドキュメントを参照してください。現在のドキュメントでは、MAS統合が有効になっている場合、このSynapse APIは利用できないと記載されています。その場合は、MAS Admin APIまたはCLIを使用してください。

よくある設定ミス

  • 誤ったファイルを変更している可能性があります。コンテナがマウントされたファイルを読み取ろうとしている一方で、ホスト側には別のコピーが存在する場合があります。実行中のSynapseプロセスが使用するパスを確認してください。
  • 再起動を忘れないでください。設定変更はサービスによって読み取られるため、テキスト編集が成功しただけでは、新しいポリシーが有効になったとは言えません。
  • 登録が無効になっている場合、すべての経路がブロックされます。設定済みの共有シークレットはアカウント作成パスとして残ります。管理自動化が必要かどうかに応じて、保護するか削除してください。
  • トークンを有効にして登録を無効にしても、 registration_requires_token登録は単独では有効になりません。意図したフローを実現するには、両方のフラグを有効にする必要があります。
  • 招待制トークンがすべての不正利用を防ぐと仮定しても、再利用可能なトークンが漏洩した場合、意図しない人物によって使用される可能性があります。使用回数を制限し、可能な限り有効期限を設定し、トークンは非公開で配布してください。

結果を確認する

Synapse の再起動後、サインアウトしたセッションを使用して Matrix クライアントでホームサーバーの登録フローを開きます。サーバーがクローズされている場合、クライアントは公開サインアップを正常に完了するオプションを提供しませんが、既存のユーザーは引き続きサインインできます。トークンによる登録の場合は、トークンなしでフローを実行し、トークンが要求されることを確認します。次に、制御されたテスト アカウントでテスト トークンを使用して、登録が成功することを確認します。結果が意図したポリシーと異なる場合は、Synapse ログと Admin API トークンのステータスを確認してください。実際の招待トークンを使用すると、許可されている唯一の使用回数を消費してしまう場合は、実際の招待トークンを使用したテストは避けてください。

公式資料

コメントを残す

SynapseでMatrixサインアップを閉鎖するか、招待トークンを必須にする

自己ホスト型のSynapseサーバーでの新規アカウント作成を停止するか、登録を招待制にし、使用回数に制限のある登録トークンを使用するようにしてください。

要素セッションID警告:ログインを安全に確認してください

信頼できるデバイスまたはリカバリキーを使用して、Elementの未検証セッション警告をクリアします。暗号化されたチャット履歴を保護するチェック機能も備えています。

適切なバックエンドを使用してownCloudのファイルロックタイムアウトを解消する

データベースロックの競合と期限切れのWebDAVロックを区別し、適切なownCloud 10の修正プログラムを選択して設定します。

ownCloud Webを開くと空白ページが表示される場合の確認事項

ownCloud Webを開くと空白ページが表示される場合の確認事項

ownCloudのWeb画面が空白になる原因を、ブラウザのキャッシュ、Webアセットの欠落、サービスエラー、またはリバースプロキシのURL設定など、特定のチェック項目に絞り込んで特定します。

ownCloud PHPメモリ警告を正しい実行時にクリアする

ownCloudのWeb PHPメモリ制限を設定し、該当するサービスを再起動し、CLI設定やアップロード制限と混同しないように注意しながら、有効な値を確認してください。

ownCloud 10のMySQL接続障害のトラブルシューティング

mySQL、PHP、ソケット設定、またはデータベース権限がownCloud 10の動作を妨げているかどうかを確認し、安全な修正方法を検証してください。

ownCloudの公開リンクに厳格な有効期限を設定する

ownCloudの公開リンクに厳格な有効期限を設定する

ownCloud Classicで公開リンクの有効期限を必須に設定し、最大有効期間を設定し、別途クリーンアップが必要な既存の共有フォルダを確認してください。

keycloakを使用してownCloud Infinite ScaleにTOTP二要素認証ログインを追加する

keycloakを使用してownCloud Infinite ScaleにTOTP二要素認証ログインを追加する

Keycloak経由でTOTPを有効にし、ユーザーを安全に登録し、Infinite ScaleのルートレベルのMFA設定が適用されるタイミングを理解します。

ownCloudの同期を復元するには、クライアントをサーバーに一致させてください。

問題がOC10と7.xの互換性の問題なのか、それともCSyncジャーナルの破損なのかを確認し、同期済みファイルを削除せずに適切な修正を適用してください。

ownCloudをLet's EncryptとNginxを使ってHTTPSで運用する

ownCloudをLet's EncryptとNginxを使ってHTTPSで運用する

HTTP-01またはDNS-01を選択し、ownCloudリバースプロキシを設定して、CertbotがHTTPS証明書を自動的に更新することを確認してください。