Caddy
O casdoor-forward-auth coloca o single sign-on do Casdoor na frente de qualquer serviço atrás do Caddy, sem alterar o serviço. O Caddy pergunta ao casdoor-forward-auth sobre cada solicitação através da sua diretiva interna forward_auth: usuários autenticados acessam o serviço com sua identidade nos cabeçalhos da requisição, enquanto todos os outros são enviados primeiro para a página de login do Casdoor.
O mesmo serviço também funciona com Traefik e Nginx. A configuração nesta página foi testada de ponta a ponta com Caddy v2.11 e casdoor-forward-auth v2.0.
Como funciona
- Caddy envia cada solicitação para um site protegido para
/authdo casdoor-forward-auth. - Com um cookie de sessão válido,
/authresponde200com cabeçalhos comoX-Forwarded-User, e o Caddy os copia na solicitação para o seu serviço. - Sem uma sessão, carregamentos de página (
GET,HEAD) são redirecionados para o Casdoor. Outras solicitações (POST,PUT, ...) recebem401, pois não podem seguir um redirecionamento de login. O Caddy retorna essas respostas ao navegador sem alterações. - Após o login, o Casdoor redireciona para
/callback. O casdoor-forward-auth verifica ostate, troca o código de autorização, valida o token de acesso, armazena o usuário em um cookie de sessãoHttpOnlyassinado e envia o usuário de volta à página solicitada.
Pré-requisitos
- Caddy v2
- Uma instância do Casdoor (consulte Instalação do Servidor)
- Dois nomes de host apontando para o Caddy, por exemplo,
auth.example.compara casdoor-forward-auth eapp.example.compara o serviço protegido
Etapa 1: Configurar a aplicação no Casdoor
-
Crie ou edite uma aplicação no Casdoor.
-
Adicione o callback do casdoor-forward-auth às Redirect URLs:
https://auth.example.com/callback -
Anote o Client ID e o Client secret.
Etapa 2: Implantar casdoor-forward-auth e Caddy
Crie um 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 é o serviço que você está protegendo. Para proteger mais serviços, atribua o mesmo bloco forward_auth a cada site. Não coloque forward_auth no site do próprio casdoor-forward-auth.
Crie um 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:
Substitua os marcadores de posição:
CASDOOR_ENDPOINT: a URL do seu servidor CasdoorCLIENT_IDeCLIENT_SECRET: os valores da Etapa 1EXTERNAL_URL: a URL pública do casdoor-forward-auth.<EXTERNAL_URL>/callbackdeve ser uma Redirect URL da aplicaçãoCOOKIE_DOMAIN: o domínio pai dos hosts protegidos, para que o cookie de sessão seja enviado a todos elesCOOKIE_SECRET: um segredo aleatório, por exemplo, gerado poropenssl rand -hex 32. Mantenha-o estável: alterá-lo desconecta todos os usuários
O Caddy obtém certificados HTTPS para ambos os hosts automaticamente. Inicie os serviços:
docker compose up -d
Etapa 3: Testar a integração
- Abra o serviço protegido, por exemplo,
https://app.example.com. - Você será redirecionado para a página de login do Casdoor.
- Após fazer login, você volta à página aberta e o serviço recebe os cabeçalhos de identidade.
traefik/whoamiimprime esses cabeçalhos, então você pode verificá-los lá.
Cabeçalhos de identidade
| 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 |
O casdoor-forward-auth sempre retorna todos eles, possivelmente vazios, para que o copy_headers do Caddy substitua o que o cliente enviou nos mesmos cabeçalhos. Certifique-se de que o serviço protegido só seja acessível através do Caddy; caso contrário, qualquer pessoa poderá enviar esses cabeçalhos diretamente.
Restringindo o acesso
Por padrão, todos os usuários que conseguem fazer login na aplicação do Casdoor são permitidos. Para permitir apenas usuários com determinadas funções ou grupos do Casdoor, adicione roles e/ou groups (separados por vírgula) ao uri daquele site:
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
}
Um usuário passa se tiver pelo menos uma das funções listadas e, se groups também for fornecido (por exemplo, groups=built-in/dev), pelo menos um dos grupos listados. Todos os outros usuários conectados recebem 403. Cada site pode ter sua própria regra; as variáveis de ambiente ALLOWED_ROLES e ALLOWED_GROUPS definem uma única regra para todos os sites.
Isso também cobre "cadastre-se primeiro, obtenha acesso depois": novos usuários, por exemplo, via cadastro pelo Google, não têm função e recebem 403 até que um administrador atribua uma na página Roles do Casdoor. Funções e grupos são lidos no momento do login, então, após uma alteração, o usuário precisa abrir https://auth.example.com/logout e fazer login novamente, ou aguardar o término da sessão (SESSION_TTL).
Configuração e logout
O casdoor-forward-auth é configurado com as mesmas variáveis de ambiente para qualquer proxy reverso; consulte Configuração na página do Traefik. /logout limpa a sessão do casdoor-forward-auth (com ?rd=<url> para redirecionar depois); o usuário permanece conectado ao Casdoor.