認証システム

一般

概要については、こちらで提供されているユーザーガイドを参照してください: Authentication

一般的な設定の概要は以下の通りです。

注: OpenID および SAML は、登録のみを無効にする機能をサポートしていません。

クイックヒント:

• 登録が無効になっている場合でも、以下で詳述する the create-user script を使用して、データベースに直接ユーザーを追加できます。
• ユーザーを削除するには、以下で詳しく説明されているdelete-userスクリプトを使用できます。

セッションの有効期限とリフレッシュトークン

• デフォルト値: セッションの有効期限: 15分、リフレッシュトークンの有効期限: 7日
  • 詳細については、こちらをご覧ください: GitHub PR #927 - Refresh Token

sequenceDiagram
    Client->>Server: Login request with credentials
    Server->>Passport: Use authentication strategy (e.g., 'local', 'google', etc.)
    Passport-->>Server: User object or false/error
    Note over Server: If valid user...
    Server->>Server: Generate access and refresh tokens
    Server->>Database: Store hashed refresh token
    Server-->>Client: Access token and refresh token
    Client->>Client: Store access token in HTTP Header and refresh token in HttpOnly cookie
    Client->>Server: Request with access token from HTTP Header
    Server-->>Client: Requested data
    Note over Client,Server: Access token expires
    Client->>Server: Request with expired access token
    Server-->>Client: Unauthorized
    Client->>Server: Request with refresh token from HttpOnly cookie
    Server->>Database: Retrieve hashed refresh token
    Server->>Server: Compare hash of provided refresh token with stored hash
    Note over Server: If hashes match...
    Server-->>Client: New access token and refresh token
    Client->>Server: Retry request with new access token
    Server-->>Client: Requested data

JWT Secret と Refresh Secret

• 新しい安全な値を使用する必要があります。提供されている例は32バイトのキー（16進数で64文字）です。
  • 以下のツールを使用して、いくつか素早く生成してください： JWT Keys

自動モデレーションシステム (オプション)

自動モデレーションシステムはデフォルトで有効になっています。このシステムはスコアリングメカニズムを使用して、ユーザーの違反を追跡します。ユーザーが過度なログイン、登録、メッセージ送信などの行為を行うと、違反スコアが蓄積されます。設定されたしきい値に達すると、そのユーザーとIPアドレスは一時的にBAN（禁止）されます。このシステムは、急速な、または疑わしいアクティビティを監視およびペナルティを課すことで、プラットフォームのセキュリティを確保します。

mod systemをセットアップするには、セットアップガイドを確認してください。

注意: 開発モードで動作させるには、ルートディレクトリに .env.development という名前のファイルを作成し、DOMAIN_CLIENT を http://localhost:3090、または npm run frontend-dev を実行した際に vite によって提供されるポート番号に設定する必要があります。

ユーザー管理スクリプト

ユーザー・スクリプトの作成

create-user スクリプトを使用すると、登録が無効になっている場合でも、データベースに直接ユーザーを追加できます。使用方法は以下の通りです：

1. デフォルトの docker-compose.yml の場合（docker compose up を使用してアプリを起動する場合）:

   docker compose exec api npm run create-user

2. deploy-compose.yml については（Ubuntu Docker Guide に従った場合）：

   docker exec -it LibreChat-API /bin/sh -c "cd .. && npm run create-user"

3. ローカル開発用（プロジェクトルートから）:

   npm run create-user

プロンプトに従って、新しいユーザーのメールアドレスとパスワードを入力してください。

ユーザー削除スクリプト

ユーザーを削除するには、delete-user スクリプトを使用できます：

1. デフォルトの docker-compose.yml の場合（docker compose up を使用してアプリを起動する場合）:

   docker compose exec api npm run delete-user [email protected]

2. deploy-compose.yml については（Ubuntu Docker Guide に従った場合）：

   docker exec -it LibreChat-API /bin/sh -c "cd .. && npm run delete-user [email protected]"

3. ローカル開発用（プロジェクトルートから）:

   npm run delete-user [email protected]

[email protected] を、削除したいユーザーのメールアドレスに置き換えてください。