Перейти до основного вмісту

Caddy

casdoor-forward-auth забезпечує одноразовий вхід (SSO) через Casdoor для будь-якої служби за Caddy без зміни самої служби. Caddy звертається до casdoor-forward-auth щодо кожного запиту через вбудовану директиву forward_auth: авторизовані користувачі отримують доступ до служби разом зі своїми даними в заголовках запиту, а всі інші спочатку перенаправляються на сторінку входу Casdoor.

Та сама служба також працює з Traefik та Nginx. Конфігурацію на цій сторінці протестовано кінцевим чином з Caddy v2.11 та casdoor-forward-auth v2.0.

Як це працює​

  1. Caddy надсилає кожен запит для захищеного сайту на /auth casdoor-forward-auth.
  2. За наявності дійсного сеансового cookie, /auth відповідає 200 із заголовками на кшталт X-Forwarded-User, а Caddy копіює їх у запит до вашого сервісу.
  3. Без сеансу завантаження сторінок (GET, HEAD) перенаправляються на Casdoor. Інші запити (POST, PUT, ...) отримують 401, оскільки вони не можуть виконати перенаправлення для входу. Caddy повертає ці відповіді браузеру без змін.
  4. Після входу Casdoor перенаправляє на /callback. casdoor-forward-auth перевіряє state, обмінює код авторизації, верифікує токен доступу, зберігає користувача в підписаному HttpOnly сеансовому cookie та повертає користувача на сторінку, яку він запитував.

Необхідні умови​

  • Caddy v2
  • Екземпляр Casdoor (див. Server Installation)
  • Два імена хостів, що вказують на Caddy, наприклад, auth.example.com для casdoor-forward-auth та app.example.com для захищеного сервісу

Крок 1: Налаштування додатка Casdoor​

  1. Створіть або відредагуйте додаток у Casdoor.

  2. Додайте callback casdoor-forward-auth до Redirect URLs:

    https://auth.example.com/callback
  3. Запишіть 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. Не розміщуйте forward_auth на сайті самого casdoor-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: URL вашого сервера Casdoor
  • CLIENT_ID та CLIENT_SECRET: значення з Кроку 1
  • EXTERNAL_URL: публічний URL casdoor-forward-auth. <EXTERNAL_URL>/callback має бути Redirect URL додатка
  • COOKIE_DOMAIN: батьківський домен захищених хостів, щоб сеансовий cookie надсилався всім їм
  • COOKIE_SECRET: випадковий секрет, наприклад, з openssl rand -hex 32. Зберігайте його стабільним: зміна цього значення завершить сеанси всіх користувачів

Caddy автоматично отримує HTTPS сертифікати для обох хостів. Запустіть служби:

docker compose up -d

Крок 3: Тестування інтеграції​

  1. Відкрийте захищений сервіс, наприклад, https://app.example.com.
  2. Ви будете перенаправлені на сторінку входу Casdoor.
  3. Після входу ви повернетеся на відкриту сторінку, а сервіс отримає заголовки ідентифікації. traefik/whoami виводить їх, тому ви можете перевірити їх там.

Заголовки ідентифікації​

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 завжди повертає всі ці заголовки, можливо порожніми, тому copy_headers у Caddy замінює будь-які значення, надіслані клієнтом у тих самих заголовках. Переконайтеся, що захищений сервіс доступний лише через Caddy, інакше будь-хто зможе надсилати ці заголовки напряму.

Обмеження доступу​

За замовчуванням допускається кожен користувач, який може увійти в додаток Casdoor. Щоб допустити лише користувачів із певними ролями або групами Casdoor, додайте roles та/або groups (розділені комою) до uri цього сайту:

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
}

Користувач проходить перевірку, якщо має хоча б одну зі списаних ролей і, якщо також задано groups (наприклад, groups=built-in/dev), хоча б одну зі списаних груп. Усім іншим увійшлим користувачам повертається 403. Кожен сайт може мати своє власне правило; змінні середовища ALLOWED_ROLES та ALLOWED_GROUPS встановлюють одне правило для всіх сайтів.

Це також покриває сценарій "спочатку зареєструйся, потім отримай доступ": нові користувачі, наприклад, через реєстрацію Google, не мають ролі й отримують 403, доки адміністратор не призначить їм роль на сторінці Roles Casdoor. Ролі та групи зчитуються під час входу, тому після зміни користувач повинен відкрити https://auth.example.com/logout і увійти знову, або чекати закінчення сеансу (SESSION_TTL).

Налаштування та вихід​

casdoor-forward-auth налаштовується тими самими змінними середовища для будь-якого зворотного проксі; див. Configuration на сторінці Traefik. /logout очищає сеанс casdoor-forward-auth (з ?rd=<url> для перенаправлення після цього); користувач залишається авторизованим у Casdoor.