tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3165 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: f6e753eaeb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f6e753eaeb'
${ noResults }
abp-next-admin2/docs/wiki/微服务架构/认证服务/身份验证流程/外部认证集成.md

14 KiB
Raw Blame History

外部认证集成

**本文档引用的文件** - [Login.cshtml.cs](file://aspnet-core\modules\account\LINGYUN.Abp.Account.Web\Pages\Account\Login.cshtml.cs) - [OAuthExternalProviderService.cs](file://aspnet-core\modules\account\LINGYUN.Abp.Account.Web.OAuth\ExternalProviders\OAuthExternalProviderService.cs) - [WeChatOfficialOAuthHandler.cs](file://aspnet-core\framework\authentication\LINGYUN.Abp.Authentication.WeChat\Microsoft\AspNetCore\Authentication\WeChat\Official\WeChatOfficialOAuthHandler.cs) - [QQConnectOAuthHandler.cs](file://aspnet-core\framework\authentication\LINGYUN.Abp.Authentication.QQ\Microsoft\AspNetCore\Authentication\QQ\QQConnectOAuthHandler.cs) - [AbpAuthenticationWeChatConsts.cs](file://aspnet-core\framework\authentication\LINGYUN.Abp.Authentication.WeChat\LINGYUN\Abp\Authentication\WeChat\AbpAuthenticationWeChatConsts.cs) - [AbpAuthenticationQQConsts.cs](file://aspnet-core\framework\authentication\LINGYUN.Abp.Authentication.QQ\LINGYUN\Abp\Authentication\QQ\AbpAuthenticationQQConsts.cs) - [ExternalLoginBind.cshtml.cs](file://aspnet-core\modules\account\LINGYUN.Abp.Account.Web\Pages\Account\ExternalLoginBind.cshtml.cs) - [AccountOAuthFeatureDefinitionProvider.cs](file://aspnet-core\modules\account\LINGYUN.Abp.Account.OAuth\LINGYUN\Abp\Account\OAuth\Features\AccountOAuthFeatureDefinitionProvider.cs)

目录

  1. 简介
  2. 项目结构
  3. 核心组件
  4. 架构概述
  5. 详细组件分析
  6. 依赖分析
  7. 性能考虑
  8. 故障排除指南
  9. 结论

简介

本文档详细介绍了如何通过OAuth2/OpenID Connect协议集成微信、QQ等第三方登录。文档解释了ExternalLoginProvider模型和AuthenticationSchemeProvider的协作机制，详细说明了OnPostExternalLogin和OnGetExternalLoginCallbackAsync方法的实现，包括身份信息映射、用户关联和安全日志记录。同时提供了第三方应用配置指南和常见问题解决方案。

项目结构

外部认证功能主要分布在两个框架模块中：LINGYUN.Abp.Authentication.WeChat 和 LINGYUN.Abp.Authentication.QQ，以及账户模块中的相关页面和服务。这些模块实现了与微信和QQ的OAuth2集成，并通过统一的接口提供给应用程序使用。

graph TD
subgraph "认证框架"
WeChat[微信认证模块]
QQ[QQ认证模块]
end
subgraph "账户模块"
Login[登录页面]
ExternalProvider[外部提供者服务]
Bind[绑定页面]
end
WeChat --> Login
QQ --> Login
ExternalProvider --> Login
Login --> Bind

图表来源

  • WeChatOfficialOAuthHandler.cs
  • QQConnectOAuthHandler.cs
  • Login.cshtml.cs

章节来源

  • Login.cshtml.cs
  • OAuthExternalProviderService.cs

核心组件

外部认证系统的核心组件包括外部登录提供者模型(ExternalLoginProviderModel)、外部提供者服务(OAuthExternalProviderService)以及具体的认证处理程序(如WeChatOfficialOAuthHandler和QQConnectOAuthHandler)。这些组件协同工作，实现了第三方登录的完整流程。

章节来源

  • ExternalLoginProviderModel.cs
  • OAuthExternalProviderService.cs

架构概述

系统的外部认证架构基于ASP.NET Core的认证体系，通过AuthenticationSchemeProvider获取所有可用的认证方案，并根据功能开关决定是否启用特定的第三方登录。当用户选择第三方登录时，系统会重定向到相应的OAuth授权服务器，完成授权后回调处理用户信息。

sequenceDiagram
participant User as "用户"
participant Login as "登录页面"
participant Provider as "认证提供者"
participant OAuthServer as "OAuth服务器"
User->>Login : 访问登录页面
Login->>Login : 获取可用的外部提供者
Login-->>User : 显示第三方登录选项
User->>Login : 选择第三方登录
Login->>Provider : 配置认证属性
Provider->>OAuthServer : 重定向到授权URL
OAuthServer-->>User : 显示授权页面
User->>OAuthServer : 授权同意
OAuthServer->>Login : 回调并返回code
Login->>Provider : 使用code换取access token
Provider->>Provider : 获取用户信息
Provider->>Login : 创建认证票据
Login->>User : 登录成功并重定向

图表来源

  • Login.cshtml.cs
  • WeChatOfficialOAuthHandler.cs
  • QQConnectOAuthHandler.cs

详细组件分析

外部登录提供者模型分析

ExternalLoginProviderModel类定义了外部登录提供者的基本信息，包括名称、显示名称、认证方案和组件类型。这个模型用于在前端展示可用的第三方登录选项。

classDiagram
class ExternalLoginProviderModel {
+Type ComponentType
+string Name
+string DisplayName
+string AuthenticationScheme
}

图表来源

  • ExternalLoginProviderModel.cs

外部提供者服务分析

OAuthExternalProviderService服务负责获取所有可用的外部登录提供者。它通过IAuthenticationSchemeProvider获取所有认证方案，并根据功能开关过滤出启用的提供者。

flowchart TD
Start([开始]) --> GetSchemes["获取所有认证方案"]
GetSchemes --> Loop{"遍历每个方案"}
Loop --> |是启用的| AddProvider["添加到结果列表"]
AddProvider --> Loop
Loop --> |否| Loop
Loop --> End([返回结果])

图表来源

  • OAuthExternalProviderService.cs

微信认证处理程序分析

WeChatOfficialOAuthHandler实现了微信官方OAuth2认证流程，包括构建授权URL、交换access token和创建用户票据三个主要步骤。

sequenceDiagram
participant Handler as "WeChatOfficialOAuthHandler"
participant OAuthServer as "微信OAuth服务器"
Handler->>Handler : 初始化处理程序
Handler->>Handler : 设置客户端ID和密钥
Handler->>OAuthServer : 构建挑战URL
OAuthServer-->>Handler : 返回授权页面
Handler->>OAuthServer : 用户授权后返回code
Handler->>OAuthServer : 使用code换取access token
OAuthServer-->>Handler : 返回access token
Handler->>OAuthServer : 使用access token获取用户信息
OAuthServer-->>Handler : 返回用户信息
Handler->>Handler : 创建认证票据

图表来源

  • WeChatOfficialOAuthHandler.cs

QQ认证处理程序分析

QQConnectOAuthHandler实现了QQ互联的OAuth2认证流程，与微信类似，但有一些特定于QQ的实现细节，如获取OpenID和用户信息的方式。

sequenceDiagram
participant Handler as "QQConnectOAuthHandler"
participant OAuthServer as "QQ OAuth服务器"
Handler->>Handler : 初始化处理程序
Handler->>Handler : 设置客户端ID和密钥
Handler->>OAuthServer : 构建挑战URL
OAuthServer-->>Handler : 返回授权页面
Handler->>OAuthServer : 用户授权后返回code
Handler->>OAuthServer : 使用code换取access token
OAuthServer-->>Handler : 返回access token
Handler->>OAuthServer : 使用access token获取OpenID
OAuthServer-->>Handler : 返回OpenID
Handler->>OAuthServer : 使用access token和OpenID获取用户信息
OAuthServer-->>Handler : 返回用户信息
Handler->>Handler : 创建认证票据

图表来源

  • QQConnectOAuthHandler.cs

OnPostExternalLogin方法分析

OnPostExternalLogin方法处理用户发起第三方登录请求的POST操作。它配置外部认证属性并重定向到相应的OAuth服务器。

flowchart TD
Start([开始]) --> ValidateInput["验证输入参数"]
ValidateInput --> BuildRedirect["构建重定向URL"]
BuildRedirect --> ConfigureProperties["配置认证属性"]
ConfigureProperties --> Challenge["发起Challenge操作"]
Challenge --> End([结束])

图表来源

  • Login.cshtml.cs

OnGetExternalLoginCallbackAsync方法分析

OnGetExternalLoginCallbackAsync方法处理OAuth服务器回调，完成用户登录或注册流程。

flowchart TD
Start([开始]) --> CheckError["检查远程错误"]
CheckError --> |有错误| HandleError["处理错误"]
CheckError --> |无错误| GetLoginInfo["获取外部登录信息"]
GetLoginInfo --> CheckLoginInfo["检查登录信息"]
CheckLoginInfo --> |为空| RedirectToLogin["重定向到登录页"]
CheckLoginInfo --> |不为空| SignIn["尝试外部登录"]
SignIn --> CheckResult["检查登录结果"]
CheckResult --> |成功| FindUser["查找用户"]
CheckResult --> |失败| SaveLog["保存安全日志"]
FindUser --> ClearCache["清除动态声明缓存"]
ClearCache --> Redirect["重定向到安全URL"]
CheckResult --> |被锁定| HandleLocked["处理锁定用户"]
CheckResult --> |不允许| HandleNotAllowed["处理不允许的用户"]
CheckResult --> |未成功| GetEmail["获取邮箱"]
GetEmail --> |为空| RedirectToRegister["重定向到注册页"]
GetEmail --> |不为空| FindByEmail["通过邮箱查找用户"]
FindByEmail --> |不存在| RedirectToRegister["重定向到注册页"]
FindByEmail --> |存在| AddLogin["添加登录信息"]
AddLogin --> SignInUser["登录用户"]
SignInUser --> SaveLog["保存安全日志"]
SaveLog --> ClearCache["清除动态声明缓存"]
ClearCache --> Redirect["重定向到安全URL"]

图表来源

  • Login.cshtml.cs

章节来源

  • Login.cshtml.cs

依赖分析

外部认证系统依赖于多个核心组件和第三方库，包括ASP.NET Core的身份认证系统、ABP框架的基础服务以及特定于微信和QQ的SDK。

graph TD
subgraph "核心依赖"
Identity[ASP.NET Core Identity]
Authentication[ASP.NET Core Authentication]
AbpFramework[ABP框架]
end
subgraph "第三方依赖"
WeChatSDK[微信SDK]
QQSDK[QQ SDK]
end
ExternalAuth[外部认证] --> Identity
ExternalAuth --> Authentication
ExternalAuth --> AbpFramework
ExternalAuth --> WeChatSDK
ExternalAuth --> QQSDK

图表来源

  • go.mod
  • go.mod

章节来源

  • WeChatOfficialOAuthHandler.cs
  • QQConnectOAuthHandler.cs

性能考虑

外部认证系统的性能主要受网络延迟和第三方API响应时间的影响。建议实施以下优化措施：

  • 对第三方API调用进行缓存
  • 实现异步处理以避免阻塞主线程
  • 使用连接池管理HTTP客户端
  • 监控和限制并发请求

故障排除指南

常见问题及解决方案

  1. 无法显示第三方登录选项

    • 检查功能开关是否已启用
    • 确认认证方案已正确注册
    • 验证配置文件中的AppId和AppSecret

  2. 回调时出现"state not valid"错误

    • 检查Cookie策略设置
    • 确保HTTPS配置正确
    • 验证反向代理配置

  3. 获取用户信息失败

    • 检查access token是否有效
    • 验证API权限设置
    • 查看第三方平台的配额限制

章节来源

  • Login.cshtml.cs
  • WeChatOfficialOAuthHandler.cs
  • QQConnectOAuthHandler.cs

结论

本文档详细介绍了外部认证集成的实现机制，包括微信和QQ的OAuth2集成、ExternalLoginProvider模型和AuthenticationSchemeProvider的协作机制，以及OnPostExternalLogin和OnGetExternalLoginCallbackAsync方法的具体实现。通过这些组件的协同工作，系统能够安全、高效地支持第三方登录功能。