Security

セキュリティ

openshell-plus は OpenShell gateway をブラウザから操作するための非公式 UI です。 公開範囲に応じてトークン認証を必須にし、URL へのトークン露出を避ける設計にしています。 環境変数の一覧は リファレンス を参照してください。

方針

認証方式

OSUI_AUTH_TOKEN を設定すると、すべての /api/* と WebSocket ハンドシェイクが保護されます。クライアントからトークンを渡す方法は次の 3 つです。

方式用途既定
Authorization: Bearer <token>REST / SSE。CLI・スクリプト・通常の fetch から利用有効
Sec-WebSocket-Protocol: bearer.<token>WebSocket。ブラウザは WS に独自ヘッダを付けられないため、同梱 UI もこの方式を使用有効
?token=<token>(クエリ)ヘッダを付けられない旧来のクライアント向けの互換手段無効(OSUI_ALLOW_QUERY_TOKEN=true で有効化)
なぜクエリトークンを既定で無効にしているか URL に含めたトークンは、リバースプロキシのアクセスログ、ブラウザの履歴やオートコンプリート、 他サイトへ遷移する際の Referer ヘッダなど、保護されない場所に残ります。 同梱 UI は subprotocol 方式に移行済みのため、通常はクエリ方式を有効にする必要はありません。

リモート gateway への接続(mTLS / OIDC)

公開前チェックリスト

項目確認方法
1トークンを設定したOSUI_AUTH_TOKEN に十分長いランダム値を設定
2公開 bind を理解しているOSUI_HOST を loopback 以外にする場合、トークン未設定では起動しないことを確認
3?token= を有効にしていないOSUI_ALLOW_QUERY_TOKEN が未設定(false)であること
4gateway への接続が TLS非 loopback gateway へは mTLS / OIDC / TLS を使用
5demo のまま公開していない実 gateway に接続できない環境で公開する場合、demo backend である旨を利用者へ明示(UI の DEMO MODE バナー)
6信頼境界を確認したリバースプロキシ・トンネル越しにアクセスログへトークンが残らない構成か

既知の制約と免責