Passer au contenu principal

Caddy

casdoor-forward-auth place le single sign-on de Casdoor devant n'importe quel service situé derrière Caddy, sans modifier le service. Caddy interroge casdoor-forward-auth pour chaque requête via sa directive intégrée forward_auth : les utilisateurs connectés accèdent au service avec leur identité dans les en-têtes de requête, tandis que les autres sont d'abord redirigés vers la page de connexion Casdoor.

Le même service fonctionne également avec Traefik et Nginx. La configuration décrite sur cette page a été testée de bout en bout avec Caddy v2.11 et casdoor-forward-auth v2.0.

Comment ça fonctionne​

  1. Caddy envoie chaque requête pour un site protégé à /auth de casdoor-forward-auth.
  2. Avec un cookie de session valide, /auth répond 200 avec des en-têtes tels que X-Forwarded-User, et Caddy les copie dans la requête adressée à votre service.
  3. Sans session, les chargements de pages (GET, HEAD) sont redirigés vers Casdoor. Les autres requêtes (POST, PUT, ...) reçoivent une réponse 401, car elles ne peuvent pas suivre une redirection de connexion. Caddy renvoie ces réponses au navigateur sans modification.
  4. Après la connexion, Casdoor redirige vers /callback. casdoor-forward-auth vérifie le state, échange le code d'autorisation, valide le jeton d'accès, stocke l'utilisateur dans un cookie de session signé HttpOnly et renvoie l'utilisateur vers la page demandée.

Prérequis​

  • Caddy v2
  • Une instance Casdoor (voir Installation du serveur)
  • Deux noms d'hôtes pointant vers Caddy, par ex., auth.example.com pour casdoor-forward-auth et app.example.com pour le service protégé

Étape 1 : Configurer l'application Casdoor​

  1. Créez ou modifiez une application dans Casdoor.

  2. Ajoutez le callback de casdoor-forward-auth dans Redirect URLs :

    https://auth.example.com/callback
  3. Notez le Client ID et le Client secret.

Étape 2 : Déployer casdoor-forward-auth et Caddy​

Créez un fichier 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 est le service que vous protégez. Pour protéger d'autres services, donnez à chaque site le même bloc forward_auth. Ne placez pas forward_auth sur le site de casdoor-forward-auth lui-même.

Créez un fichier 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:

Remplacez les espaces réservés :

  • CASDOOR_ENDPOINT : l'URL de votre serveur Casdoor
  • CLIENT_ID et CLIENT_SECRET : les valeurs obtenues lors de l'étape 1
  • EXTERNAL_URL : l'URL publique de casdoor-forward-auth. <EXTERNAL_URL>/callback doit être une URL de redirection (Redirect URL) de l'application
  • COOKIE_DOMAIN : le domaine parent des hôtes protégés, afin que le cookie de session soit envoyé à tous
  • COOKIE_SECRET : un secret aléatoire, par exemple généré avec openssl rand -hex 32. Gardez-le stable : le modifier déconnectera tous les utilisateurs

Caddy obtient automatiquement des certificats HTTPS pour les deux hôtes. Démarrez les services :

docker compose up -d

Étape 3 : Tester l'intégration​

  1. Ouvrez le service protégé, par exemple https://app.example.com.
  2. Vous êtes redirigé vers la page de connexion Casdoor.
  3. Après la connexion, vous revenez sur la page ouverte, et le service reçoit les en-têtes d'identité. traefik/whoami les affiche, ce qui permet de les vérifier.

En-têtes d'identité​

HeaderValue
X-Forwarded-UserUser name, e.g., alice
X-Forwarded-User-IdUser ID
X-Forwarded-OrganizationOrganization of the user
X-Forwarded-EmailEmail address
X-Forwarded-GroupsComma-separated groups, e.g., built-in/dev,built-in/ops
X-Forwarded-RolesComma-separated role names

casdoor-forward-auth renvoie toujours tous ces en-têtes, éventuellement vides, afin que copy_headers de Caddy remplace ceux envoyés par le client avec le même nom. Assurez-vous que le service protégé n'est accessible que via Caddy, sinon n'importe qui pourrait envoyer directement ces en-têtes.

Restriction d'accès​

Par défaut, tout utilisateur pouvant se connecter à l'application Casdoor est autorisé. Pour n'autoriser que les utilisateurs ayant certains rôles ou groupes Casdoor, ajoutez roles et/ou groups (séparés par des virgules) à l'uri du site concerné :

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
}

Un utilisateur est autorisé s'il possède au moins un des rôles listés et, si groups est également spécifié (par exemple groups=built-in/dev), au moins un des groupes listés. Tout autre utilisateur connecté reçoit une erreur 403. Chaque site peut avoir sa propre règle ; les variables d'environnement ALLOWED_ROLES et ALLOWED_GROUPS définissent une règle unique pour tous les sites.

Cela couvre également le scénario « inscription d'abord, accès plus tard » : les nouveaux utilisateurs, par exemple via Google sign-up, n'ont aucun rôle et reçoivent une erreur 403 jusqu'à ce qu'un administrateur leur en attribue un sur la page Roles de Casdoor. Les rôles et groupes sont lus lors de la connexion ; après une modification, l'utilisateur doit ouvrir https://auth.example.com/logout et se reconnecter, ou attendre la fin de la session (SESSION_TTL).

Configuration et déconnexion​

casdoor-forward-auth est configuré avec les mêmes variables d'environnement quel que soit le proxy inverse ; voir Configuration sur la page Traefik. /logout efface la session de casdoor-forward-auth (avec ?rd=<url> pour effectuer une redirection ensuite) ; l'utilisateur reste connecté à Casdoor.