.netcore 极速接入第三方登录

新年新气象,趁着新年的喜庆,肝了十来天,终于发了第一版,希望大家喜欢。

如果有不喜欢看文字的童鞋,可以直接看下面的地址体验一下:

  • Github: https://github.com/mrhuo/MrHuo.OAuth

  • 唯一官网:https://oauthlogin.net

前言

此次带来的这个小项目是 OAuth2 登录组件,看到 Java 平台 JustAuth 项目很方便的接入第三方平台登录,心里痒痒啊,搜了一大圈,发现我大 .netcore 能用的可说是少之又少,而且代码写得一塌糊涂,全在一个库里,代码风格也看不惯,所以下定决定,操起键盘,开干。

关于 OAuth2 的一些基础、原理介绍文章太多了,写的好的不在少数,在页尾我提供了几个链接,喜欢的朋友看一下,这里就不深入解释,直入主题。

如何使用

这里拿接入 github 登录做演示,新建 Asp.NET Core Web应用程序 项目,名叫 GithubLogin(PS:你可以自己起个和更牛×的名字),选择模型视图控制器这个,当然你可以选择其他的。

第一步:安装

安装这个 nuget 包:

Install-Package MrHuo.OAuth.Github -Version 1.0.0

第二步:配置

打开 appsettings.json 写入下面的配置:

{"oauth": {"github": {"app_id": "github_app_id","app_key": "github_app_key","redirect_uri": "https://oauthlogin.net/oauth/githubcallback","scope": "repo"}}
}

这里的配置可以通过 https://github.com/settings/applications/new 来注册,redirect_uri 可以填写本地 localhost 地址的,超级方便,这也是为什么使用 github 登录做演示的原因。

创建完成后,在这个界面里生成 client secret

输入密码,生成成功后是这样的:

把界面里的 Client IDClient secret,连同上一个界面里填写的 Authorization callback URL 全部填写到配置文件对应位置。现在配置文件 appsettings.json 是这样的:

{"Logging": {"LogLevel": {"Default": "Information","Microsoft": "Warning","Microsoft.Hosting.Lifetime": "Information"}},"AllowedHosts": "*","oauth": {"github": {"app_id": "c95fxxxxxx0d09","app_key": "c6a73xxxxxx6375","redirect_uri": "http://localhost:5000/oauth/githubcallback","scope": "repo"}}
}

下面的 scope 暂且不管他,你想深入了解它的作用的话,后面再说。

第三步:写代码

Startup.cs 文件中注入组件:

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{services.AddControllersWithViews();services.AddSingleton(new GithubOAuth(OAuthConfig.LoadFrom(Configuration, "oauth:github")));
}

文件中其他代码没有修改,只加了这一行而已。

新建一个 OAuthController 类,代码如下:

using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using MrHuo.OAuth.Github;
namespace GithubLogin.Controllers
{public class OAuthController: Controller{[HttpGet("oauth/github")]public IActionResult Github([FromServices] GithubOAuth githubOAuth){return Redirect(githubOAuth.GetAuthorizeUrl());}[HttpGet("oauth/githubcallback")]public async Task<IActionResult> GithubCallback([FromServices] GithubOAuth githubOAuth,[FromQuery] string code){return Json(await githubOAuth.AuthorizeCallback(code));}}
}

你没看错,就这点代码就好了。我们来运行一下试试:

项目运行之后,在地址栏里输入下面这个地址:http://localhost:5000/oauth/github,因为我们没有修改任何代码,没有在视图上做任何链接,所以就劳烦手动啦~~

回车之后,顺利跳转到 github 授权:

点击绿色的 Authorize 按钮之后稍等片刻,你会看到下面这个结果:

顺利拿到了用户信息(PS:请忽略我少的可怜的粉丝,曾经我不强求 --ToT)

好了,到这里我的表演结束了,可以看到接入流程非常流畅,卡人主要是在申请这些步骤。下面讲讲原理之类的,随便说一些...如果觉得我啰嗦,那么就不用往下看了,因为下面我会更啰嗦。

当然,除了 github 现在已经接入了12个平台,其中 QQ 和抖音我没有注册到应用,无法测试,所以暂时没有 nuget 包,一个人的力量总是有限的,在这里我请求各位有闲时间或者有 appid 资源的大佬,为这个小项目做一些贡献,是她走的远一些。

更多的 nuget 包,进这里 https://www.nuget.org/profiles/mrhuo 或者在 VS nuget 包管理器里搜索 MrHuo.OAuth,就可以了。

请忽略 nuget 上其他几个 垃圾 包,那是很多年很多年以前写的,舍不得删。

开发背景

第三方平台登录说白了就是实现 OAuth2 协议,很多平台比如支付宝、百度、github、微软,甚至是抖音、快手很多平台都提供了开放接口。但是,很多平台会在这个标准协议的基础上增加、修改一些东西,比如:标准协议里,获取 authorize code 时应提供 client_id,微信公众平台非要把它改成 appid。再比如:获取用户信息时,只需要 access_token 参数,微信公众平台这边非要提供一个 openid,当然这是在所难免的,因为各个平台实际业务还是千差万别,无法做到完全的统一,那这就给我们开发者带来一个困扰,开发第三方登录时很困难,当然,开发一两个也无所谓,要是多了呢?

假如有这么一个产品经理,他想接入很多的登录方式,让使用者无论使用哪种平台,都能在这里顺利登录,找到回家的路呢(PS:产品经理你别跑,看我40米的大刀)。

无疑,给我们一个考验,如何做到一个标准化,可配置,可扩展呢?这就是一个需要深究的问题。下面我就说说我肝这个项目的一些想法,说的不好别喷我,我还年轻(PS:三十多岁老大叔别装嫩),还要脸......

制定标准

看了很多文档之后,我们会发现,万变不离其宗,总有规律可循,总的来说,有下面3个步骤:

  1. GetAuthorizeUrl

这一步通过 client_idredirect_uri 等几个参数来获取授权 url,跳转到这个 url 之后将在第三方平台上完成登录,完成登录之后会跳转到上面提供的 redirect_uri 这个地址,并且带上一个 code 参数。

  1. GetAccessToken

这一步里,拿到上面的 code 之后去第三方平台换 access_token

  1. GetUserInfo

这一步并非必须,但是我们既然是做第三方登录,登录之后还是需要和自己平台的一些业务绑定用户账号,或者使用现有信息注册一个用户,这个方法就显得尤为重要了。

到此,就这3个步骤,我觉得是需要制定在标准里面的,所以我就写了下面这个接口来规范它:

/// <summary>
/// OAuth 登录 API 接口规范
/// </summary>
public interface IOAuthLoginApi<TAccessTokenModel, TUserInfoModel>where TAccessTokenModel : IAccessTokenModelwhere TUserInfoModel : IUserInfoModel
{/// <summary>/// 获取跳转授权的 URL/// </summary>/// <param name="state"></param>/// <returns></returns>string GetAuthorizeUrl(string state = "");/// <summary>/// 异步获取 AccessToken/// </summary>/// <param name="code"></param>/// <param name="state"></param>/// <returns></returns>Task<TAccessTokenModel> GetAccessTokenAsync(string code, string state = "");/// <summary>/// 异步获取用户详细信息/// </summary>/// <param name="accessTokenModel"></param>/// <returns></returns>Task<TUserInfoModel> GetUserInfoAsync(TAccessTokenModel accessTokenModel);
}

可以看到我将 AccessTokenUserInfo 做成了泛型参数,因为他们是这个规范里的可变部分。代码中 state 参数的作用呢就是为了防止 CORS 攻击做的防伪验证,这里暂不做解释,其他文档里都有这个参数的解释。

如何扩展新的平台

这里拿 Gitee 来做演示:

第一步:找平台对应 OAuth 文档,找到获取用户信息接口返回JSON,转换为 C# 实体类。如下:

根据自己需要和接口标准,扩展用户属性

public class GiteeUserModel : IUserInfoModel
{[JsonPropertyName("name")]public string Name { get; set; }[JsonPropertyName("avatar_url")]public string Avatar { get; set; }[JsonPropertyName("message")]public string ErrorMessage { get; set; }[JsonPropertyName("email")]public string Email { get; set; }[JsonPropertyName("blog")]public string Blog { get; set; }//...其他属性类似如上
}

这里使用了 .netcore 内置的 Json 序列化库,据说性能提高了不少!

第二步:写对应平台的授权接口

/// <summary>
/// https://gitee.com/api/v5/oauth_doc#/
/// </summary>
public class GiteeOAuth : OAuthLoginBase<GiteeUserModel>
{public GiteeOAuth(OAuthConfig oauthConfig) : base(oauthConfig) { }protected override string AuthorizeUrl => "https://gitee.com/oauth/authorize";protected override string AccessTokenUrl => "https://gitee.com/oauth/token";protected override string UserInfoUrl => "https://gitee.com/api/v5/user";
}

加上注释,总共十行,如你所见,非常方便。如果该平台协议遵循 OAuth2 标准开发,那么就这么几行就好了。


当然,如果不按规矩自定义字段的平台,也可以扩展,比如微信公众平台。

WechatAccessTokenModel.cs AccessToken 类扩展

namespace MrHuo.OAuth.Wechat
{public class WechatAccessTokenModel : DefaultAccessTokenModel{[JsonPropertyName("openid")]public string OpenId { get; set; }}
}

继承自 DefaultAccessTokenModel,新增字段 OpenId,因为获取用户信息需要获取 OpenId,所以这里需要它。

WechatUserInfoModel.cs 用户信息类

using System.Collections.Generic;
using System.Text.Json.Serialization;namespace MrHuo.OAuth.Wechat
{public class WechatUserInfoModel : IUserInfoModel{[JsonPropertyName("nickname")]public string Name { get; set; }[JsonPropertyName("headimgurl")]public string Avatar { get; set; }[JsonPropertyName("language")]public string Language { get; set; }[JsonPropertyName("openid")]public string Openid { get; set; }[JsonPropertyName("sex")]public int Sex { get; set; }[JsonPropertyName("province")]public string Province { get; set; }[JsonPropertyName("city")]public string City { get; set; }[JsonPropertyName("country")]public string Country { get; set; }/// <summary>/// 用户特权信息,json 数组,如微信沃卡用户为(chinaunicom)/// </summary>[JsonPropertyName("privilege")]public List<string> Privilege { get; set; }[JsonPropertyName("unionid")]public string UnionId { get; set; }[JsonPropertyName("errmsg")]public string ErrorMessage { get; set; }}
}

这里用户信息字段上边的 [JsonPropertyName("xxxx")] 完全按照文档里的字段写,否则获取不到正确的值。如果不需要太多的字段,自行删减。

WechatOAuth.cs 核心类

using System.Collections.Generic;
namespace MrHuo.OAuth.Wechat
{/// <summary>/// Wechat OAuth 相关文档参考:/// <para>https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html</para>/// </summary>public class WechatOAuth : OAuthLoginBase<WechatAccessTokenModel, WechatUserInfoModel>{public WechatOAuth(OAuthConfig oauthConfig) : base(oauthConfig) { }protected override string AuthorizeUrl => "https://open.weixin.qq.com/connect/oauth2/authorize";protected override string AccessTokenUrl => "https://api.weixin.qq.com/sns/oauth2/access_token";protected override string UserInfoUrl => "https://api.weixin.qq.com/sns/userinfo";protected override Dictionary<string, string> BuildAuthorizeParams(string state){return new Dictionary<string, string>(){["response_type"] = "code",["appid"] = oauthConfig.AppId,["redirect_uri"] = System.Web.HttpUtility.UrlEncode(oauthConfig.RedirectUri),["scope"] = oauthConfig.Scope,["state"] = state};}public override string GetAuthorizeUrl(string state = ""){return $"{base.GetAuthorizeUrl(state)}#wechat_redirect";}protected override Dictionary<string, string> BuildGetAccessTokenParams(Dictionary<string, string> authorizeCallbackParams){return new Dictionary<string, string>(){["grant_type"] = "authorization_code",["appid"] = $"{oauthConfig.AppId}",["secret"] = $"{oauthConfig.AppKey}",["code"] = $"{authorizeCallbackParams["code"]}"};}protected override Dictionary<string, string> BuildGetUserInfoParams(WechatAccessTokenModel accessTokenModel){return new Dictionary<string, string>(){["access_token"] = accessTokenModel.AccessToken,["openid"] = accessTokenModel.OpenId,["lang"] = "zh_CN",};}}
}

乍一看好多内容,懵了?先别懵,我一个一个来说一下:

protected override Dictionary<string, string> BuildAuthorizeParams(string state)
{return new Dictionary<string, string>(){["response_type"] = "code",["appid"] = oauthConfig.AppId,["redirect_uri"] = System.Web.HttpUtility.UrlEncode(oauthConfig.RedirectUri),["scope"] = oauthConfig.Scope,["state"] = state};
}

细心的读者发现了,这一段就是为了构造 Authorize Url 时后边的参数列表,返回一个 Dictionary<string, string> 即可,以为微信公众号把 client_id 字段修改为 appid,所以这里需要处理一下。

public override string GetAuthorizeUrl(string state = "")
{return $"{base.GetAuthorizeUrl(state)}#wechat_redirect";
}

这一段,在 Authorize Url 后边缀了个 #wechat_redirect,虽然不知道微信在这个参数上做了什么文章(PS:知道的朋友,言传一下~~),但是他文档里写就给他写上吧。

protected override Dictionary<string, string> BuildGetAccessTokenParams(Dictionary<string, string> authorizeCallbackParams)
{return new Dictionary<string, string>(){["grant_type"] = "authorization_code",["appid"] = $"{oauthConfig.AppId}",["secret"] = $"{oauthConfig.AppKey}",["code"] = $"{authorizeCallbackParams["code"]}"};
}

同理,这一段是为了构造 GetAccessToken 接口参数。

protected override Dictionary<string, string> BuildGetUserInfoParams(WechatAccessTokenModel accessTokenModel)
{return new Dictionary<string, string>(){["access_token"] = accessTokenModel.AccessToken,["openid"] = accessTokenModel.OpenId,["lang"] = "zh_CN",};
}

同理,这一段是为了构造 GetUserInfo 接口参数。

可以看到哈,这个框架本着自由、开放的原则,任何能自定义的地方,都可以自定义。还有我原本的出发点,并非只针对 OAuth 登录这一个方向,我想把他平台里面提供的 API 全部接入进来,因为扩展太容易了,但是吧,时间精力有限,再说人上了年纪,过了30岁,脑袋就不怎么灵光了,所以机会留给年轻人。

加入贡献

期待更多的朋友能加入到这个项目中,贡献代码也好,贡献 appid 资源做测试也好,提供意见建议也好。如果你也感兴趣,请联系我。

如果觉得有用帮到你了,贡献一颗幼儿园之星 ⭐,点个关注,fork 走一波~~(PS: 手动调皮)

相关文档:

  • OAuth2:https://oauth.net/2/

  • rfc6749:https://tools.ietf.org/html/rfc6749

  • ruanyifeng:http://www.ruanyifeng.com/blog/2019/04/github-oauth.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/305708.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

linux watch 文件大小,Linux watch命令的使用

1.命令简介watch 命令以周期性的方式执行给定的命令&#xff0c;并全屏显示执行结果。watch 是一个非常实用的命令&#xff0c;基本所有的 Linux 发行版都带有。如同名字一样&#xff0c;watch 可以帮助监测一个命令的运行结果&#xff0c;省得我们一遍遍地手动运行。比如 tail…

在ISA 2006标准版上定制带宽和限制流量(测试)

最的忙于工作上的事&#xff0c;有点烦躁&#xff0c;很少有心情能静下来去看看书或是做些实验了。这是个不好的现象。 一直想着在ISA SERVER上做一些带宽和流量方面的测试&#xff0c;没有找到较好的软件。偶尔从朋友那得到一款&#xff0c;虽说是英文的&#xff0c;也蛮不错…

.NET 中 async 和 await

前言C# 中的 Async 和 Await 关键字是异步编程的核心。使用这两个关键字可以轻松创建异步方法。使用 async 关键字定义的异步方法简称“异步方法”。异步编程并发的一种形式&#xff0c;它采用furture模式或回调(callback)机制&#xff0c;以避免产生不必要的线程。.Net中futur…

Javascript 常用技巧 [2]

Javascript 常用技巧 [2] /**请问如何去掉主页右面的滚动条&#xff1f; <!-- <body scroll"no"> --> <!-- <body style"overflow-y:hidden"> --> ******************************** 怎样不使用页面的缓存&#xff1f;即每一次打…

mongodb可视化工具 linux,Linux中安装启动MongoDB与可视化工具

MongoDB 提供了 linux 各发行版本 64 位的安装包&#xff0c;你可以在官网下载安装包。下载地址&#xff1a;https://www.mongodb.com/download-center#community下载完安装包&#xff0c;并解压 tgz(以下演示的是 64 位 Linux上的安装) 。curl -O https://fastdl.mongodb.org/…

年轻有为的老黄2020

0x01 不知道开篇要说什么好&#xff0c;那就来个经典的 0x01 吧。这个世界不止苟且&#xff0c;还有诗和远方。工作 工作上面还算是比较忙碌的&#xff0c;在20年也做了很多东西&#xff0c;本来面试进公司的时候title是高开&#xff0c;在基础架构组&#xff0c;光杆部门。过完…

VS.NET调试问题

Q:VS.NET调试问题 A:关于VisualStudio.NET里调试出现的一系列问题&#xff0c;例如没有权限调试Web服务器&#xff0c;不属于Debugger Users组、无法调试等情况&#xff0c;都可以在The VS7 Debugger doesn’t work. What can I do(http://blogs.msdn.co…

linux调用odbc接口乱码,linux中pypyodbc读取GB编码mdb中文乱码解决办法

当前1.3.3版本的pypyodbc在linux系统上面已经可以读取有中文字符的mdb文件,不再出现异常,但是读取的中文字符却全是乱码。下面是根据一些现象的合理推论:mdb文件来自于windows系统,其中的中文字符使用GB编码无疑,但linux系统上mdbtools提供的odbc驱动底层已经执行了编码转换,将…

推荐:Dapper扩展-Dapper.SimpleCRUD

背景Dapper目前应该是大家比较喜欢的orm框架之一&#xff0c;但是它灵活的背后&#xff0c;还是有很多不尽人意的地方&#xff0c;谁想编写基本的读取/插入/更新/删除语句&#xff1f;下面推荐SimpleCRUD为Dapper提供了简单的CRUD帮助器。解放了大家&#xff0c;提高生产力。功…

创建虚拟磁盘的小工具软件plainmaker.exe

此小工具,在虚拟机中做集群实现时用到!其下载地址如下:[url]http://www.vmware.cn/Soft/69.html[/url]

Linux下的MySQL测试,Linux下MySQL命令(1)

启动命令&#xff1a;$ ./mysqld_safe --defaults-file/home/mysql/local/mysql_sale_mirror/etc/my.cnf --basedir/home/mysql/local/mysql_sale_mirror/ --datadir/home/mysql/local/mysql_sale_mirror/var/ --pid-file/home/mysql/local/mysql_sale_mirror/var/mysql.pid --…

深入浅出Dotnet Core的项目结构变化

有时候&#xff0c;越是基础的东西&#xff0c;越是有人不明白。前几天Review一个项目的代码&#xff0c;发现非常基础的内容&#xff0c;也会有人理解出错。今天&#xff0c;就着这个点&#xff0c;写一下Dotnet Core的主要类型的项目结构&#xff0c;以及之间的转换和演化。一…

群策群力:破机房征求灵丹妙药

我校有一年代久远之计算机教室&#xff0c;现已经迈入日落西山之境。特征求灵丹妙药&#xff0c;不求妙手回春&#xff0c;只愿其能为我校的信息技术教育事业再尽最后一把微力&#xff0c;也为我校即将面临无地授课的教师提供继续上岗的救命稻草一枝。具体情况说明&#xff1a;…

使用 C# 9 的records作为强类型ID - 路由和查询参数

上一篇文章&#xff0c;我介绍了使用 C# 9 的record类型作为强类型id&#xff0c;非常简洁public record ProductId(int Value);但是在强类型id真正可用之前&#xff0c;还有一些问题需要解决&#xff0c;比如&#xff0c;ASP.NET Core并不知道如何在路由参数或查询字符串参数中…

linux sudo 必须属于用户ID0,sudo:/usr/bin/sudo 务必属于用户 ID 0(的用户)并且设置 setuid 位...

今天手抖本来要修改/usr/bin/下面的一个文件属性为 user:user&#xff0c;执行chown -R /usr/bin/的时候&#xff0c;再按tab之前直接敲了回车&#xff1b;结果导致执行sudo命令时出现错误提示&#xff1a;“sudo&#xff1a;/usr/bin/sudo 必须属于用户 ID 0(的用户)并且设置…

企业形象广告的几个突破要点

企业形象广告的使用不能简单的说好与不好&#xff0c;特定的企业&#xff0c;特定的行业&#xff0c;有不同的功能和效果&#xff0c;一般大众化消费品较为适宜&#xff0c;但也要注意&#xff1a; 1、 如果一个企业的产品处于一个完全成熟的品牌阶段&#xff0c;不易投入大量的…

公司高层要我转Java 我直接邮件回怼...

2020年艰难而短暂&#xff0c;而互联网的历史车轮还是轰隆隆一路向前&#xff0c;服务网格/云原生/Serverless架构&#xff0c;各种新架构大行其道。重新审视当下主流的编程语言&#xff0c;天下第一的Java已老&#xff0c;下行多年的.NET却浴火重生&#xff0c;焕发生机&#…

linux如何实现网络高级编程,嵌入式Linux网络编程之:网络高级编程-嵌入式系统-与非网...

10.3 网络高级编程在实际情况中&#xff0c;人们往往遇到多个客户端连接服务器端的情况。由于之前介绍的如connet()、recv()和send()等都是阻塞性函数&#xff0c;如果资源没有准备好&#xff0c;则调用该函数的进程将进入睡眠状态&#xff0c;这样就无法处理I/O多路复用的情况…

.NET斗鱼直播弹幕客户端(2021)

.NET斗鱼直播弹幕客户端(2021)离之前更新的两篇《.NET斗鱼直播弹幕客户端》已经有一段时间&#xff0c;近期有许多客户向我反馈刚好有这方面的需求&#xff0c;但之前的代码不能用了——但网上许多流传的Node.js、Python脚本却可以用&#xff0c;这岂能忍&#xff1f;&#xff…

McAfee推免费版SiteAdvisor安全上网工具

McAfee近期宣布推出完全免费版McAfee SiteAdvisor上网工具。McAfee SiteAdvisor是业界第一款Web安全工具&#xff0c;能够主动地提醒用户在浏览、搜索和即时通信或收发电子邮件时所遇到的危险站点&#xff0c;避免遭到网络钓鱼、间谍软件等恶意程序的***。 McAfee SiteAdvisor是…