Caddy
casdoor-forward-auth は、サービスを変更することなく、Caddy の背後にあるあらゆるサービスの前に Casdoor シングルサインオンを導入します。Caddy は組み込みの forward_auth ディレクティブを通じてすべてのリクエストを casdoor-forward-auth に確認します。サインイン済みのユーザーはリクエストヘッダーにアイデンティティを含めてサービスに到達でき、それ以外のユーザーはまず Casdoor のログインページへ送られます。
同じサービスは Traefik や Nginx でも動作します。このページのセットアップは、Caddy v2.11 と casdoor-forward-auth v2.0 を使用してエンドツーエンドでテストされました。
仕組み
- Caddy は、保護されたサイトのすべてのリクエストを casdoor-forward-auth の
/authに送信します。 - 有効なセッション Cookie がある場合、
/authはX-Forwarded-Userなどのヘッダーとともに200を返し、Caddy はそれらをあなたのサービスへのリクエストにコピーします。 - セッションがない場合、ページ読み込み (
GET,HEAD) は Casdoor へリダイレクトされます。その他のリクエスト (POST,PUT, ...) は、ログインのリダイレクトに従えないため401を返します。Caddy はこれらの応答を変更せずにブラウザに返します。 - ログイン後、Casdoor は
/callbackへリダイレクトします。casdoor-forward-auth はstateを確認し、認可コードとアクセストークンを交換・検証した上で、ユーザーを署名付きのHttpOnlyセッション Cookie に保存し、ユーザーが要求したページに戻します。
前提条件
- Caddy v2
- Casdoor インスタンス (サーバーインストール を参照)
- Caddy を指す 2 つのホスト名。例えば、casdoor-forward-auth 用に
auth.example.com、保護されたサービス用にapp.example.comなどです。
ステップ 1: Casdoor アプリケーションの設定
-
Casdoor でアプリケーションを作成または編集します。
-
casdoor-forward-auth のコールバックを Redirect URLs に追加します:
https://auth.example.com/callback -
Client ID と Client secret を控えます。
ステップ 2: casdoor-forward-auth と Caddy のデプロイ
Caddyfile を作成します:
auth.example.com {
reverse_proxy casdoor-forward-auth:9999
}
app.example.com {
forward_auth casdoor-forward-auth:9999 {
uri /auth
copy_headers X-Forwarded-User X-Forwarded-User-Id X-Forwarded-Organization X-Forwarded-Email X-Forwarded-Groups X-Forwarded-Roles
}
reverse_proxy app:8080
}
app:8080 は保護するサービスです。さらに多くのサービスを保護するには、各サイトに同じ forward_auth ブロックを与えます。casdoor-forward-auth 自体のサイトには forward_auth を置かないでください。
docker-compose.yml を作成します:
services:
caddy:
image: caddy:2
ports:
- "80:80"
- "443:443"
volumes:
- ./Caddyfile:/etc/caddy/Caddyfile:ro
- caddy_data:/data
casdoor-forward-auth:
image: ghcr.io/casdoor/casdoor-forward-auth:latest
environment:
CASDOOR_ENDPOINT: https://door.casdoor.com
CLIENT_ID: <client ID>
CLIENT_SECRET: <client secret>
EXTERNAL_URL: https://auth.example.com
COOKIE_DOMAIN: example.com
COOKIE_SECRET: <random string of at least 32 characters>
app:
image: traefik/whoami
command: --port 8080
volumes:
caddy_data:
プレースホルダーを置き換えます:
CASDOOR_ENDPOINT: Casdoor サーバーの URLCLIENT_IDとCLIENT_SECRET: ステップ 1 の値EXTERNAL_URL: casdoor-forward-auth の公開 URL。<EXTERNAL_URL>/callbackはアプリケーションの Redirect URL の一つである必要がありますCOOKIE_DOMAIN: 保護されたホストの親ドメイン。これによりセッション Cookie がすべてのホストに送信されますCOOKIE_SECRET: ランダムなシークレット。例えばopenssl rand -hex 32で生成できます。安定性を保ってください: 変更すると全員がサインアウトされます
Caddy は両方のホストに対して HTTPS 証明書を自動的に取得します。サービスを開始します:
docker compose up -d
ステップ 3: 統合のテスト
- 保護されたサービスを開きます。例えば
https://app.example.comです。 - Casdoor のログインページへリダイレクトされます。
- サインイン後、開いていたページに戻り、サービスが ID ヘッダーを受信します。
traefik/whoamiはこれらを出力するため、そこで確認できます。
ID ヘッダー
| Header | Value |
|---|---|
X-Forwarded-User | User name, e.g., alice |
X-Forwarded-User-Id | User ID |
X-Forwarded-Organization | Organization of the user |
X-Forwarded-Email | Email address |
X-Forwarded-Groups | Comma-separated groups, e.g., built-in/dev,built-in/ops |
X-Forwarded-Roles | Comma-separated role names |
casdoor-forward-auth は常にすべてを返却します(空の場合もありますが)、そのため Caddy の copy_headers はクライアントが同じヘッダーで送信したものを置き換えます。保護されたサービスが Caddy を経由してのみアクセス可能であることを確認してください。さもないと、誰でもこれらのヘッダーを直接送信できてしまいます。
アクセス制限
デフォルトでは、Casdoor アプリケーションにサインインできるすべてのユーザーが許可されます。特定の Casdoor ロールまたはグループを持つユーザーのみを許可するには、そのサイトの uri に roles および/または groups(カンマ区切り)を追加します:
app.example.com {
forward_auth casdoor-forward-auth:9999 {
uri /auth?roles=admin,ops
copy_headers X-Forwarded-User X-Forwarded-User-Id X-Forwarded-Organization X-Forwarded-Email X-Forwarded-Groups X-Forwarded-Roles
}
reverse_proxy app:8080
}
ユーザーは、リストされたロールのうち少なくとも 1 つを満たせば通過し、groups も指定されている場合(例: groups=built-in/dev)、リストされたグループのうち少なくとも 1 つも満たす必要があります。それ以外のサインイン済みのユーザーは 403 を受けます。各サイトは独自ルールを持てます。ALLOWED_ROLES と ALLOWED_GROUPS 環境変数はすべてのサイトに共通のルールを設定します。
これは「まずサインアップし、後でアクセス権を得る」シナリオにも対応します。Google サインアップなどの新規ユーザーにはロールがなく、管理者が Casdoor の Roles ページで割り当てるまで 403 を受けます。ロールとグループはログイン時に読み取られるため、変更後はユーザーが https://auth.example.com/logout でサインアウトして再サインインするか、セッション終了(SESSION_TTL)を待つ必要があります。
設定とログアウト
casdoor-forward-auth はすべてのリバースプロキシで同じ環境変数を使用して設定されます。Traefik ページの Configuration を参照してください。/logout は casdoor-forward-auth のセッションをクリアします(?rd=<url> を付与するとその後リダイレクトされます)。ユーザーは Casdoor にはサインインしたままです。