Passer au contenu principal

OAuth2 Proxy

OAuth2 Proxy est un proxy inverse qui authentifie les utilisateurs via un fournisseur OIDC avant qu'ils n'accèdent à votre application. Il peut également agir comme point d'entrée forward-auth pour Nginx, Caddy ou Traefik. Avec Casdoor comme fournisseur, vous pouvez autoriser uniquement les membres d'un groupe Casdoor ou les utilisateurs possédant un rôle Casdoor.

La configuration présentée sur cette page a été testée de bout en bout avec OAuth2 Proxy v7.15 et Casdoor v4.17.

conseil

Si vous avez seulement besoin de la connexion Casdoor devant une application et n'avez pas besoin d'OAuth2 Proxy lui-même, casdoor-forward-auth fait le même travail pour Traefik, Caddy et Nginx, et transmet les groupes et rôles de l'utilisateur dans les en-têtes de requête.

Étape 1 : Créer l'application dans Casdoor​

  1. Dans l'organisation de vos utilisateurs, ajoutez une application (ou ouvrez-en une existante).

  2. Ajoutez le callback d'OAuth2 Proxy à Redirect URLs :

    https://app.example.com/oauth2/callback
  3. Sur l'onglet OIDC/OAuth, définissez :

    • Token format : JWT-Standard
    • Token group format : Name (group), afin que les groupes arrivent sous la forme devs au lieu de my-org/devs
  4. Enregistrez, et notez le Client ID et le Client secret.

Pourquoi JWT-Standard : avec le format par défaut JWT, un utilisateur dont l'e-mail n'est pas vérifié ne peut pas se connecter (OAuth2 Proxy rejette email_verified: false, et les utilisateurs créés par un administrateur ont généralement une adresse e-mail non vérifiée), et la revendication roles contient des objets de rôle complets au lieu des noms de rôles. Voir What Casdoor sends.

Étape 2 : Configurer OAuth2 Proxy​

Créez 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 est l'URL de Casdoor, sans barre oblique finale. Elle doit correspondre exactement à l'issuer affiché sur https://door.example.com/.well-known/openid-configuration. Casdoor construit l'issuer à partir de origin dans conf/app.conf, ou à partir du host de la requête si origin est vide ; si les deux diffèrent, OAuth2 Proxy échoue avec une erreur issuer did not match.
  • cookie_secret doit faire 16, 24 ou 32 octets, par exemple le résultat de openssl rand -base64 32 | tr -- '+/' '-_'.
  • Conservez la portée profile : Casdoor ne renvoie les groupes et rôles depuis son endpoint userinfo que si profile est accordé.
  • upstreams est votre application.

Démarrez-le :

oauth2-proxy --config oauth2-proxy.cfg

Ouvrez https://app.example.com. Après s'être connecté à Casdoor, les membres de devs accèdent à l'application et tous les autres reçoivent une erreur 403 Forbidden.

Restreindre l'accès par rôle plutôt que par groupe​

Pour vérifier un rôle Casdoor au lieu d'un groupe, lisez la claim roles :

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

allowed_groups contient alors des noms de rôles, sans l'organisation.

Vérifier ce qu'a reçu OAuth2 Proxy​

Après la connexion, ouvrez https://app.example.com/oauth2/userinfo. Il affiche les groupes extraits par OAuth2 Proxy :

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

Si groups est vide, l'utilisateur n'appartient à aucun groupe ou rôle dans Casdoor, ou le nom de la claim est incorrect. S'il contient de longues chaînes JSON comme {"owner":"my-org","name":"admin",...}, l'application utilise encore le format JWT par défaut avec oidc_groups_claim = "roles" ; passez au format JWT-Standard.

Ce que Casdoor envoie​

La manière dont les groupes et rôles de l'utilisateur parviennent à OAuth2 Proxy dépend du Token format de l'application :

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

Avec JWT-Standard, le token lui-même ne porte que les claims OIDC standard. OAuth2 Proxy recherche auprès de l'endpoint userinfo de Casdoor toute claim manquante dans le token, ainsi groups et roles arrivent toujours, une fois par connexion.

Token group format contrôle les valeurs de groupe dans tous les formats : ID (par défaut) donne my-org/devs, Name donne devs, et Path donne my-org/parent/devs pour les groupes imbriqués.

Pour placer les noms de rôles directement dans le token, utilisez JWT-Custom et ajoutez une ligne aux Token attributes :

NameCategoryValueType
rolesExisting FieldRolesArray

Si Token fields n'est pas vide, il limite également ce que renvoie l'endpoint userinfo (voir Token fields). Incluez Groups (et Roles si vous lisez les rôles depuis userinfo), ou laissez-le vide.

Si vous devez conserver le format JWT par défaut, ajoutez insecure_oidc_allow_unverified_email = true afin que les utilisateurs ayant une adresse e-mail non vérifiée puissent se connecter, et restreignez uniquement par groups.

Transmettre l'utilisateur à votre application​

OAuth2 Proxy ajoute ces en-têtes aux requêtes qu'il transmet (pass_user_headers, activé par défaut) :

HeaderValue
X-Forwarded-UserCasdoor user ID (the sub claim)
X-Forwarded-Preferred-UsernameNom d'utilisateur Casdoor, ex. alice
X-Forwarded-EmailEmail address
X-Forwarded-GroupsGroups (or roles), comma separated

Assurez-vous que votre application n'est accessible que via OAuth2 Proxy, sinon n'importe qui peut envoyer ces en-têtes directement.

Pour utiliser OAuth2 Proxy comme point d'entrée forward-auth de Nginx (auth_request), Caddy (forward_auth) ou Traefik (forwardAuth) au lieu d'un reverse proxy, dirigez le proxy vers son endpoint /oauth2/auth ; voir Integrations dans la documentation d'OAuth2 Proxy.

Dépannage​

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.