メインコンテンツにスキップ

OAuth2 Proxy

OAuth2 Proxy は、アプリケーションに到達する前に OIDC プロバイダーを使用してユーザーをサインインするリバースプロキシです。Nginx、Caddy、Traefik の forward-auth エンドポイントとしても機能できます。プロバイダーとして Casdoor を使用すると、Casdoor グループのメンバーまたは Casdoor ロールを持つユーザーのみを受け入れることができます。

このページの構成は、OAuth2 Proxy v7.15 と Casdoor v4.17 でエンドツーエンドでテストされました。

ヒント

アプリケーションの前に Casdoor サインインのみが必要で、OAuth2 Proxy 自体が必要ない場合は、casdoor-forward-auth が Traefik、Caddy、および Nginx に対して同じ機能を提供し、リクエストヘッダーでユーザーのグループとロールを渡します。

ステップ 1: Casdoor でアプリケーションを作成する​

  1. ユーザーの組織内で、アプリケーションを追加するか、既存のアプリケーションを開きます。

  2. Redirect URLs に OAuth2 Proxy のコールバックを追加します:

    https://app.example.com/oauth2/callback
  3. OIDC/OAuth タブで次を設定します:

    • Token format: JWT-Standard
    • Token group format: Name (group)。これにより、グループは my-org/devs ではなく devs として届きます。
  4. 保存し、Client ID と Client secret を控えます。

JWT-Standard を使用する理由: デフォルトの JWT フォーマットでは、メールアドレスが検証されていないユーザーはサインインできません(OAuth2 Proxy は email_verified: false を拒否し、管理者によって作成されたユーザーは通常、未検証のメールアドレスを持っています)。また、roles クレームにはロール名ではなく完全なロールオブジェクトが含まれます。Casdoor が送信する内容を参照してください。

ステップ 2: OAuth2 Proxy を構成する​

oauth2-proxy.cfg を作成します:

provider = "oidc"
oidc_issuer_url = "https://door.example.com"
client_id = "<client ID>"
client_secret = "<client secret>"
redirect_url = "https://app.example.com/oauth2/callback"
scope = "openid email profile"
email_domains = ["*"]

cookie_secret = "<random secret>"
http_address = "0.0.0.0:4180"
upstreams = ["http://127.0.0.1:8080"]

# Let in only members of the Casdoor group "devs"
oidc_groups_claim = "groups"
allowed_groups = ["devs"]
  • oidc_issuer_url は末尾のスラッシュを除いた Casdoor の URL です。これは https://door.example.com/.well-known/openid-configuration で表示される issuer と完全に一致する必要があります。Casdoor は conf/app.conf の origin から issuer を構築するか、origin が空の場合はリクエストのホストから構築します。この 2 つが異なる場合、OAuth2 Proxy は issuer did not match エラーで失敗します。
  • cookie_secret は 16、24、または 32 バイトである必要があります。例えば openssl rand -base64 32 | tr -- '+/' '-_' の出力を使用します。
  • profile スコープを保持してください。Casdoor は profile が許可されている場合にのみ、userinfo エンドポイントからグループとロールを返します。
  • upstreams はあなたのアプリケーションです。

起動します:

oauth2-proxy --config oauth2-proxy.cfg

https://app.example.com を開きます。Casdoor にサインインした後、devs のメンバーはアプリケーションにアクセスでき、その他のすべてのユーザーは 403 Forbidden を受け取ります。

代わりにロールによるアクセス制限​

グループの代わりに Casdoor ロールを確認するには、roles クレームを読み取ります:

oidc_groups_claim = "roles"
allowed_groups = ["admin"]

allowed_groups には、組織名を除いたロール名が含まれます。

OAuth2 Proxy が受信した内容を確認する​

サインイン後、https://app.example.com/oauth2/userinfo を開きます。これは OAuth2 Proxy が抽出したグループを表示します:

{"user":"d1a5f427-...","email":"alice@example.com","groups":["devs"],"preferredUsername":"alice"}

groups が空の場合、ユーザーは Casdoor にグループまたはロールを持っていないか、クレーム名が間違っています。{"owner":"my-org","name":"admin",...} のような長い JSON 文字列が含まれている場合、アプリケーションはまだデフォルトの JWT フォーマットを oidc_groups_claim = "roles" と共に使用しています。フォーマットを JWT-Standard に切り替えてください。

Casdoor が送信する内容​

ユーザーのグループとロールが OAuth2 Proxy に届く方法は、アプリケーションの Token format に依存します:

Token formatgroupsrolesUnverified email
JWT-Standardfrom userinfo, group namesfrom userinfo, role namessigns in
JWT-Customin the token if Groups is in Token fieldsin the token if you add a token attribute roles (see below)signs in
JWT (default)in the tokenrole objects, not usable for allowed_groupsrejected
JWT-Emptyin the tokenfrom userinfo, role namessigns in

JWT-Standard では、トークン自体には標準的な OIDC クレームのみが含まれます。OAuth2 Proxy は、トークンに欠けているクレームを Casdoor の userinfo エンドポイントで検索するため、groups と roles はサインインごとに一度だけ届きます。

Token group format はすべてのフォーマットでのグループ値を制御します: ID(デフォルト)は my-org/devs を返し、Name は devs を返し、ネストされたグループの場合 Path は my-org/parent/devs を返します。

ロール名をトークン自体に含めるには、JWT-Custom を使用し、Token attributes に次の行を追加します:

NameCategoryValueType
rolesExisting FieldRolesArray

Token fields が空でない場合、userinfo エンドポイントが返す内容も制限されます(Token fields を参照)。Groups(および userinfo からロールを読み取る場合は Roles)を含めるか、空のままにしてください。

デフォルトの JWT フォーマットを使用する必要がある場合は、メール認証が完了していないユーザーでもサインインできるように insecure_oidc_allow_unverified_email = true を設定し、groups のみで制限してください。

ユーザーをアプリケーションに渡す​

OAuth2 Proxy は、転送するリクエストにこれらのヘッダーを追加します(pass_user_headers、デフォルトで有効):

HeaderValue
X-Forwarded-UserCasdoor user ID (the sub claim)
X-Forwarded-Preferred-UsernameCasdoor ユーザー名、例: alice
X-Forwarded-EmailEmail address
X-Forwarded-GroupsGroups (or roles), comma separated

アプリケーションが OAuth2 Proxy 経由でのみアクセス可能であることを確認してください。そうでない場合、誰でもこれらのヘッダーを直接送信できてしまいます。

OAuth2 Proxy をリバースプロキシとしてではなく、Nginx(auth_request)、Caddy(forward_auth)、または Traefik(forwardAuth)の forward-auth エンドポイントとして使用するには、プロキシを /oauth2/auth エンドポイントに向けます。詳細については、OAuth2 Proxy ドキュメントの Integrations を参照してください。

トラブルシューティング​

SymptomCause and fix
issuer did not match the issuer returned by provider at startupoidc_issuer_url differs from the issuer in Casdoor's discovery document. Set origin in Casdoor's conf/app.conf to its public URL and use the same value here.
500 after sign-in, log says email in id_token ... isn't verifiedThe application uses the default JWT format and the user's email is not verified. Switch to JWT-Standard, or set insecure_oidc_allow_unverified_email = true.
403 Forbidden after sign-inThe user is not in allowed_groups. Open /oauth2/userinfo to see what OAuth2 Proxy received and compare it with Token group format.
Casdoor shows Redirect URI: ... doesn't exist in the allowed Redirect URI listAdd https://app.example.com/oauth2/callback to the application's Redirect URLs.