OAuth2-Proxy与Nginx多子域名认证配置指南

背景介绍

OAuth2-Proxy是一个流行的开源反向代理和单点登录解决方案，它允许开发者为没有内置认证机制的服务添加OAuth2认证层。在实际部署中，常见的一个需求是通过单个OAuth2-Proxy实例保护多个后端服务，同时使用Nginx作为前端代理。

常见配置问题

许多开发者在尝试配置OAuth2-Proxy保护多个子域名服务时会遇到以下典型错误：

[main.go:54] invalid configuration:
  multiple upstreams found with id "/": upstream ids must be unique
  multiple upstreams found with path "/": upstream paths must be unique

这个错误表明OAuth2-Proxy无法处理多个使用相同路径("/")的上游服务配置。

解决方案分析

方案一：直接代理模式

在直接代理模式下，OAuth2-Proxy作为中间层位于Nginx和后端服务之间。这种架构的流量路径为：

用户 → Nginx → OAuth2-Proxy → 后端服务

这种模式的主要限制是：

1. 每个上游服务必须配置唯一的路径
2. 无法直接通过不同子域名区分服务

方案二：Nginx auth_request模式

更推荐的解决方案是利用Nginx的auth_request模块实现认证分离。这种架构的流量路径为：

用户 → Nginx (主代理) → 后端服务 ↓ OAuth2-Proxy (认证)

这种模式的优势在于：

1. 可以灵活支持多个子域名
2. 认证与流量转发解耦
3. 配置更加清晰和可维护

详细配置建议

OAuth2-Proxy配置要点

1. 启用反向代理模式：

   reverse_proxy = true
   

2. 配置正确的cookie作用域：

   cookie_domains = [".yourdomain.com"]
   

3. 设置白名单域名：

   whitelist_domains = ["sub1.yourdomain.com", "sub2.yourdomain.com"]
   

Nginx配置要点

1. 为每个需要保护的位置块添加auth_request指令：

   location / {
       auth_request /oauth2/auth;
       error_page 401 = /oauth2/sign_in;
   }
   

2. 配置认证端点：

   location /oauth2/ {
       proxy_pass http://oauth2-proxy:4180;
       proxy_set_header Host $host;
       proxy_set_header X-Real-IP $remote_addr;
   }
   

3. 处理认证回调：

   location /oauth2/callback {
       proxy_pass http://oauth2-proxy:4180;
       proxy_set_header Host $host;
       proxy_set_header X-Real-IP $remote_addr;
   }
   

常见问题排查

1. 401未授权错误：

   • 检查cookie域配置是否正确
   • 验证OAuth2提供商回调URL设置
   • 确保Nginx传递了正确的Host头

2. 无限重定向循环：

   • 检查白名单域名配置
   • 验证cookie安全设置
   • 确保error_page配置正确

3. 跨子域名会话不共享：

   • 确认cookie_domains配置包含父域
   • 检查cookie_secure和cookie_httponly设置

最佳实践建议

1. 为生产环境使用HTTPS
2. 定期轮换客户端密钥和cookie密钥
3. 监控认证日志以检测异常行为
4. 考虑实现会话持久化以提高用户体验
5. 为不同安全级别的服务配置不同的OAuth2作用域

通过以上配置和最佳实践，开发者可以构建一个既安全又灵活的多子域名认证系统，满足各种业务场景的需求。