Asp.Net Core中虽然集成了许多常用的身份认证,但很多时候,我们还是需要实现自己的身份认证接口,本文这里就简单的介绍下如何实现自定义身份认证接口。
首先写一个简单的接口。
[Authorize]
[HttpGet]
public object Foo()
{
return DateTime.Now.ToString();
}
由于有Authorize标记,访问函数体前会判断用户是否通过认证,由于这里没有通过认证,会的得到一个500错误。
自定义认证处理类:
实现一个IAuthenticationHandler接口即可:
1 public class MyAuthHandler : IAuthenticationHandler
2 {
3 public const string SchemeName = "MyAuth";
4
5 AuthenticationScheme _scheme;
6 HttpContext _context;
7
8 /// <summary>
9 /// 初始化认证
10 /// </summary>
11 public Task InitializeAsync(AuthenticationScheme scheme, HttpContext context)
12 {
13 _scheme = scheme;
14 _context = context;
15 return Task.CompletedTask;
16 }
17
18 /// <summary>
19 /// 认证处理
20 /// </summary>
21 public Task<AuthenticateResult> AuthenticateAsync()
22 {
23 var req = _context.Request.Query;
24 var isLogin = req["isLogin"].FirstOrDefault();
25
26 if (isLogin != "true")
27 {
28 return Task.FromResult(AuthenticateResult.Fail("未登陆"));
29 }
30
31 var ticket = GetAuthTicket("test", "test");
32 return Task.FromResult(AuthenticateResult.Success(ticket));
33 }
34
35 AuthenticationTicket GetAuthTicket(string name, string role)
36 {
37 var claimsIdentity = new ClaimsIdentity(new Claim[]
38 {
39 new Claim(ClaimTypes.Name, name),
40 new Claim(ClaimTypes.Role, role),
41 }, "My_Auth");
42
43 var principal = new ClaimsPrincipal(claimsIdentity);
44 return new AuthenticationTicket(principal, _scheme.Name);
45 }
46
47 /// <summary>
48 /// 权限不足时的处理
49 /// </summary>
50 public Task ForbidAsync(AuthenticationProperties properties)
51 {
52 _context.Response.StatusCode = (int)HttpStatusCode.Forbidden;
53 return Task.CompletedTask;
54 }
55
56 /// <summary>
57 /// 未登录时的处理
58 /// </summary>
59 public Task ChallengeAsync(AuthenticationProperties properties)
60 {
61 _context.Response.StatusCode = (int)HttpStatusCode.Unauthorized;
62 return Task.CompletedTask;
63 }
64 }
主体函数是AuthenticateAsync,主要进行了如下几步
- 首先是根据http上下文判断用户是否通过认证,这里我实现的比较简单,判断下querystring中的IsLogin是否为true,为true则通过验证。
- 如果通过认证,则生成一个ClaimsPrincipal对象,返回认证成功
ClaimsPrincipal对象它是.net core的验证模型。ASP.NET Core 的验证模型是 claims-based authentication,网上有一些文章来介绍他Introduction to Authentication with ASP.NET Core。他们代表的意义如下:
- Claim 是用户信息,例如用户名,角色,邮件。一般常用的是用户名和角色。特别是角色,经常接用于授权信息中。
- 一组claims构成了一个identity,构成了 ClaimsIdentity对象,可以把ClaimsIdentity理解为"证件",驾照是一种证件,护照也是一种证件。理解记录了用户的基本信息。
- ClaimsIdentity的持有者就是 ClaimsPrincipal ,一个ClaimsPrincipal可以持有多个ClaimsIdentity,就比如一个人既持有驾照,又持有护照。
认证通过后,也可以通过HttpContext.User属性获取这个对象,从而获取用户名,角色等信息
注册自定义认证处理类:
在startup.cs中进行如下配置:
- 开启身份验证中间件
app.UseAuthentication();
app.UseAuthorization();
- 配置选项
services.AddAuthentication(options =>
{
options.AddScheme<MyAuthHandler>(MyAuthHandler.SchemeName, "default scheme");
options.DefaultAuthenticateScheme = MyAuthHandler.SchemeName;
options.DefaultChallengeScheme = MyAuthHandler.SchemeName;
});
测试:
上述功能完成后,再进行前面的测试,在url中带上认证信息访问:
可以看到这次能成功访问接口,说明认证信息是生效了的。