> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 認証

> Basic AuthでAPIを保護し、QRコード、コードまたはパスキーをペアリングして各WhatsAppアカウントをペアリングします。

GOWAには2種類の認証があります。

1. **APIアクセス**: GOWAを呼び出す可能性があります。これがHTTPベーシック認証です。
2. **WhatsAppのペアリング**:WhatsAppのWebをリンクするように、WhatsAppアカウントをデバイススロットにリンクします。

## APIアクセス: Basic認証

Basic Authは唯一のAPI認証方法です。REST呼び出しのAPIキーやJWTはありません。

1つ以上の `user:password` ペアを設定してください。カンマ区切り:

```bash theme={null}
# environment
APP_BASIC_AUTH=admin:changeme,ops:another-secret
# or flag
./whatsapp rest --basic-auth=admin:changeme,ops:another-secret
```

すべてのエントリには、ユーザー名とパスワードを含める必要があります。デフォルトのリスナーである `APP_HOST=0.0.0.0`、完全な資格情報なしで開始することを拒否します。認証なしのローカル開発では、`APP_HOST=127.0.0.1` をバインドします。

リバースプロキシがすべての呼び出し元を認証する場合、`APP_ALLOW_UNAUTHENTICATED=true` または `--allow-unauthenticated=true` は、Basic 認証なしでノンループバックリスナーを明示的に許可します。

リクエストごとに認証情報を送信:

```bash theme={null}
curl -u admin:changeme http://localhost:3000/app/info
# same as
curl -H "Authorization: Basic YWRtaW46Y2hhbmdlbWU=" http://localhost:3000/app/info
```

認証情報が見つからないか間違っていると、 `401 Unauthorized` が返されます。

### Basic 認証の背後にないもの

| ルート | なぜ |
| - | - |
| `GET /health` | 生存性探索。`APP_BASE_PATH` を無視して常にルートにあります。 |
| `POST /chatwoot/webhook`, `POST /chatwoot/webhook/{device_id}` | Chatwootによって呼び出されます。代わりに`CHATWOOT_ENABLED=true`と`CHATWOOT_WEBHOOK_SECRET`で保護されている場合にのみ登録されます。 [Chatwoot](https://gowa-docs.mintlify.site/ja/integrations/chatwoot.md) を参照してください。 |
| MCP OAuthの発見と`/oauth/*` エンドポイント | `MCP_OAUTH_ENABLED=true` の場合のみ。[MCP server](https://gowa-docs.mintlify.site/ja/integrations/mcp.md) を参照してください。 |
| `GET /statics/*` | Basic Authの前に提供されています。ファイルのURLを知っている人は誰でもそれを取得できます。 JPEG、PNG、GIF、および画像パス内の WebP ファイルのみがインライン表示されます。 他のファイルは、アクティブではないコンテンツタイプと `X-Content-Type-Options: nosniff` の添付ファイルとしてダウンロードします。必要に応じてプロキシでファイルアクセスを制限します。 |

`/`、`/mcp`、`/ws`のダッシュボードを含めると、基本的な認証が必要になります。

### WebSocket

ブラウザーはWebSocket接続でヘッダーを設定できないため、`/ws`はクエリ文字列の認証情報を取得します。

```text theme={null}
ws://localhost:3000/ws?device_id=my-device&authorization=YWRtaW46Y2hhbmdlbWU=
```

`authorization` は `base64(user:password)` です。TLS (`wss://`) を使用して、プロキシログのクエリ文字列をredact します。 WebSocket は、状態変化する HTTP 要求に使用されるのと同じ信頼できるオリジンとブラウザーのオリジンを照合します。 現在のWebSocketハブは、接続されているすべてのソケットにイベントをブロードキャストします。 `device_id` クエリは、接続のデバイスコンテキストを選択しますが、イベントの配信は分離されません。 イベントのデバイス識別子を使用して、ダッシュボードビューをフィルタリングし、すべてのデバイスで信頼されている呼び出し元のみに API アクセスを許可します。

イベントコード、ペイロード、クライアントの例については、[WebSocket リファレンス](https://gowa-docs.mintlify.site/ja/api-reference/websocket.md)を参照してください。

### CORS

CORS はデフォルトで任意のオリジンを許可します。`APP_CORS_ALLOWED_ORIGINS=https://ui.example.com` (カンマ区切り)でそれを制限してください。許可されているリクエストヘッダーは `Origin` 、 `Content-Type` 、 `Accept` 、 `Authorization` 、 `X-Device-Id` です。

CORSとブラウザーのオリジンチェックは分離されています。ワイルドカードCORSオリジンは状態を変更するリクエストやWebSocketを許可しません。 GOWAは、リクエスト自身のホスト、特定のCORSオリジン、`APP_TRUSTED_ORIGINS`を信頼し、OAuth発行者とChatwootコールバックURLに設定されたオリジンを信頼します。 別のダッシュボードの場合、その正確な原点を設定します。

```env theme={null}
APP_CORS_ALLOWED_ORIGINS=https://ui.example.com
APP_TRUSTED_ORIGINS=https://ui.example.com
```

信頼されていないブラウザーからの変更リクエストには、`403 CROSS_SITE_REQUEST_BLOCKED` が返されます。ログイン、ログアウト、再接続、招待リンクのリセットを行う GET ルートも対象です。curl など、ブラウザーのオリジンを示すヘッダーを送信しないクライアントは引き続き利用できます。

`null`オリジンは信頼されていません。`file://`のURLとして開く代わりに、HTTPまたはHTTPS経由で`gowa-ui.html`を提供します。 リバースプロキシの背後で、 `Host` を保持し、 `X-Forwarded-Host` で信頼できるプロキシを設定し、 `APP_TRUSTED_ORIGINS` で公開オリジンを一覧表示します。

## WhatsAppのペア

すべてのWhatsAppアカウントは**デバイススロット**にあります。まずスロットを作成し、ペアリングしてください。 `/devices/{device_id}`の下のルートは、デバイスをパスから取ります。同等のルート`/app/*`は、`X-Device-Id`ヘッダーを使用します。

```bash theme={null}
curl -u admin:changeme -X POST http://localhost:3000/devices \
  -H "Content-Type: application/json" -d '{"device_id": "sales"}'
```

### QR code

```bash theme={null}
curl -u admin:changeme http://localhost:3000/devices/sales/login
```

```json theme={null}
{
  "code": "SUCCESS",
  "message": "Login success",
  "results": {
    "device_id": "sales",
    "qr_link": "http://localhost:3000/statics/qrcode/scan-qr-b0b7bb43-....png",
    "qr_duration": 30
  }
}
```

`qr_link`を開き、電話からスキャンします: **設定 → リンクされたデバイス → デバイスをリンク**。 `qr_duration`秒後に新しいコードを要求します。`/`のダッシュボードはQRを直接表示し、WebSocketを介してライブで更新します。

### Pairing code

```bash theme={null}
curl -u admin:changeme -X POST \
  "http://localhost:3000/devices/sales/login/code?phone=628123456789"
```

応答には `results.pair_code` が含まれています。電話では**電話番号とリンク** を選択し、入力してください。 `phone` は、国コードと連携させるアカウントの数でなければなりません。

### パスワード

QR ログイン中にパスキーの確認を求められた場合、GOWAはWebAuthnチャレンジを保存し、WebSocketに`PASSKEY_REQUEST`をブロードキャストします。 ダッシュボードがこのフローを処理します。自分でドライブするには次のようにします。

1. `GET /app/passkey` は保留中のチャレンジを返します。
2. `POST /app/passkey/response` は WebAuthn assertion(`PublicKeyCredential.toJSON()`形式)を送信します。
3. `PASSKEY_CONFIRMATION` を待ちます。`result.skip_handoff_ux` がtrueの場合、有効なQRフローは自動的に確認を送信します。 それ以外の場合は、`result.code` と電話のコードを比較し、`POST /app/passkey/confirm` を呼び出します。

3つの呼び出しすべてに`X-Device-Id`を送信します。

### 結果を確認する

```bash theme={null}
curl -u admin:changeme http://localhost:3000/devices/sales/status
```

`results.is_connected` と `results.is_logged_in` は、アカウントがリンクされると両方の `true` になります。セッションは `storages/`で継続されるので、再起動にはペアリングは必要ありません。

## ログアウトして削除

| アクション | Endpoint | 効果 |
| - | - | - |
| ログアウト | `POST /devices/{device_id}/logout` or `GET /app/logout` | WhatsAppからアカウントのリンクを解除し、そのセッションをクリアします. スロットは、あなたが同じIDの下で再びそれをペアリングすることができますので、残ります. |
| 再接続 | `POST /devices/{device_id}/reconnect` or `GET /app/reconnect` | 再びペアリングせずにWhatsApp接続を再開します。 |
| 削除 | `DELETE /devices/{device_id}` | ログアウトし、セッションとチャットデータと一緒にスロットを削除します。 |

電話からリンクされていないアカウント (format@@0 → format@@1) は同じようにログアウトされます。

## セキュリティチェックリスト

* ネットワークから到達可能なものには、強力なパスワードを必ず`APP_BASIC_AUTH`に設定してください。
* リバースプロキシで TLS を終了します。Basic Auth 資格情報は base64 エンコードのみです。
* ブラウザUIがAPIを呼び出すときに、`APP_CORS_ALLOWED_ORIGINS` を制限します。
* `openssl rand -hex 32` を使用して安定した `WHATSAPP_WEBHOOK_SECRET` を生成します。シークレットを空または公開した例は、再起動時に変更されるプロセスごとにランダムなキーに置き換えられます。
* `storages/`を機密として扱います。リンクされたアカウントのセッションキーがすべて含まれています。 新しいSQLiteファイルは、所有者のみの権限を使用し、それらのために作成されたディレクトリは`0700`を使用します。同じ注意を払ってバックアップを保護します。


## Related topics

- [API 認証](https://gowa-docs.mintlify.site/ja/api-reference/authentication.md)
- [APIリファレンス](https://gowa-docs.mintlify.site/ja/api-reference/introduction.md)
- [サーバーメトリック](https://gowa-docs.mintlify.site/ja/api-reference/metrics.md)
- [クイックスタート](https://gowa-docs.mintlify.site/ja/quickstart.md)
- [MCP サーバー](https://gowa-docs.mintlify.site/ja/integrations/mcp.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.