ASP.NET Core 中的身份验证和授权 SignalRAuthentication and authorization in ASP.NET Core SignalR

本文内容

作者： Andrew Stanton

查看或下载示例代码（如何下载）

对连接到 SignalR 集线器的用户进行身份验证Authenticate users connecting to a SignalR hub

SignalR 可以与ASP.NET Core authentication一起使用，以将用户与每个连接相关联。在中心中，可以从HubConnectionContext属性访问身份验证数据。身份验证允许中心对与用户关联的所有连接调用方法。有关详细信息，请参阅SignalR中的 "管理用户和组"。单个用户可能与多个链接相关联。

下面是使用 SignalR 和 ASP.NET Core 身份验证的 Startup.Configure 的示例：

  1. public void Configure(IApplicationBuilder app)
  2. {
  3.     ...
  5.     app.UseStaticFiles();
  7.     app.UseRouting();
  9.     app.UseAuthentication();
  10.     app.UseAuthorization();
  12.     app.UseEndpoints(endpoints =>
  13.     {
  14.         endpoints.MapHub<ChatHub>("/chat");
  15.         endpoints.MapControllerRoute("default", "{controller=Home}/{action=Index}/{id?}");
  16.     });
  17. }
  1. public void Configure(IApplicationBuilder app)
  2. {
  3.     ...
  5.     app.UseStaticFiles();
  7.     app.UseAuthentication();
  9.     app.UseSignalR(hubs =>
  10.     {
  11.         hubs.MapHub<ChatHub>("/chat");
  12.     });
  14.     app.UseMvc(routes =>
  15.     {
  16.         routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
  17.     });
  18. }

备注

注册 SignalR 和 ASP.NET Core 身份验证中间件的顺序。在 UseSignalR 之前始终调用 UseAuthentication，以便 SignalR 在 HttpContext上有用户。

Cookie 身份验证Cookie authentication

在基于浏览器的应用程序中，cookie 身份验证允许现有用户凭据自动流向 SignalR 连接。使用浏览器客户端时，无需额外配置。如果用户已登录到你的应用，则 SignalR 连接将自动继承此身份验证。

Cookie 是一种特定于浏览器的发送访问令牌的方式，但非浏览器客户端也可以发送这些令牌。使用.Net 客户端时，可以在 .WithUrl 调用中配置 Cookies 属性以提供 cookie。但是，从 .NET 客户端使用 cookie 身份验证要求应用提供 API 来交换 cookie 的身份验证数据。

持有者令牌身份验证Bearer token authentication

客户端可以提供访问令牌，而不是使用 cookie。服务器验证令牌并使用它来标识用户。仅在建立连接时才执行此验证。连接开启后，服务器不会通过自动重新验证来检查令牌是否撤销。

在服务器上，使用JWT 持有者中间件来配置持有者令牌身份验证。

在 JavaScript 客户端中，可使用accessTokenFactory选项提供令牌。

  1. // Connect, using the token we got.
  2. this.connection = new signalR.HubConnectionBuilder()
  3.     .withUrl("/hubs/chat", { accessTokenFactory: () => this.loginToken })
  4.     .build();

在 .NET 客户端中，有一个类似的AccessTokenProvider属性，可用于配置令牌：

  1. var connection = new HubConnectionBuilder()
  2.     .WithUrl("https://example.com/myhub", options =>
  3.     { 
  4.         options.AccessTokenProvider = () => Task.FromResult(_myAccessToken);
  5.     })
  6.     .Build();

备注

提供的访问令牌函数在 SignalR发出的每个HTTP 请求之前调用。如果你需要续订标记以便使连接保持活动状态（因为它可能会在连接期间过期），请在此函数中执行此操作，并返回已更新的令牌。

在标准 web Api 中，持有者令牌是在 HTTP 标头中发送的。但是，在使用某些传输时，SignalR 无法在浏览器中设置这些标头。使用 Websocket 和服务器发送事件时，会将令牌作为查询字符串参数进行传输。若要在服务器上支持此操作，需要进行其他配置：

  1. public void ConfigureServices(IServiceCollection services)
  2. {
  3.     services.AddDbContext<ApplicationDbContext>(options =>
  4.         options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
  6.     services.AddIdentity<ApplicationUser, IdentityRole>()
  7.         .AddEntityFrameworkStores<ApplicationDbContext>()
  8.         .AddDefaultTokenProviders();
  10.     services.AddAuthentication(options =>
  11.         {
  12.             // Identity made Cookie authentication the default.
  13.             // However, we want JWT Bearer Auth to be the default.
  14.             options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
  15.             options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
  16.         })
  17.         .AddJwtBearer(options =>
  18.         {
  19.             // Configure the Authority to the expected value for your authentication provider
  20.             // This ensures the token is appropriately validated
  21.             options.Authority = /* TODO: Insert Authority URL here */;
  23.             // We have to hook the OnMessageReceived event in order to
  24.             // allow the JWT authentication handler to read the access
  25.             // token from the query string when a WebSocket or 
  26.             // Server-Sent Events request comes in.
  28.             // Sending the access token in the query string is required due to
  29.             // a limitation in Browser APIs. We restrict it to only calls to the
  30.             // SignalR hub in this code.
  31.             // See https://docs.microsoft.com/aspnet/core/signalr/security#access-token-logging
  32.             // for more information about security considerations when using
  33.             // the query string to transmit the access token.
  34.             options.Events = new JwtBearerEvents
  35.             {
  36.                 OnMessageReceived = context =>
  37.                 {
  38.                     var accessToken = context.Request.Query["access_token"];
  40.                     // If the request is for our hub...
  41.                     var path = context.HttpContext.Request.Path;
  42.                     if (!string.IsNullOrEmpty(accessToken) &&
  43.                         (path.StartsWithSegments("/hubs/chat")))
  44.                     {
  45.                         // Read the token out of the query string
  46.                         context.Token = accessToken;
  47.                     }
  48.                     return Task.CompletedTask;
  49.                 }
  50.             };
  51.         });
  53.     services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
  55.     services.AddSignalR();
  57.     // Change to use Name as the user identifier for SignalR
  58.     // WARNING: This requires that the source of your JWT token 
  59.     // ensures that the Name claim is unique!
  60.     // If the Name claim isn't unique, users could receive messages 
  61.     // intended for a different user!
  62.     services.AddSingleton<IUserIdProvider, NameUserIdProvider>();
  64.     // Change to use email as the user identifier for SignalR
  65.     // services.AddSingleton<IUserIdProvider, EmailBasedUserIdProvider>();
  67.     // WARNING: use *either* the NameUserIdProvider *or* the 
  68.     // EmailBasedUserIdProvider, but do not use both. 
  69. }

备注

由于浏览器 API 限制，连接到 Websocket 和服务器发送事件时，将在浏览器上使用查询字符串。使用 HTTPS 时，查询字符串值受 TLS 连接保护。但是，许多服务器都记录查询字符串值。有关详细信息，请参阅ASP.NET Core SignalR中的安全注意事项。 SignalR 使用标头在支持令牌的环境（如 .NET 和 Java 客户端）中传输令牌。

Cookie 和持有者令牌Cookies vs. bearer tokens

Cookie 特定于浏览器。与发送持有者令牌相比，从其他类型的客户端发送这些客户端增加了复杂性。因此，不建议使用 cookie 身份验证，除非应用只需从浏览器客户端对用户进行身份验证。当使用浏览器客户端之外的客户端时，建议使用持有者令牌身份验证。

Windows 身份验证Windows authentication

如果在你的应用中配置了Windows 身份验证，SignalR 可以使用该标识来保护中心。但是，若要将消息发送给单个用户，则需要添加自定义用户 ID 提供程序。Windows 身份验证系统不提供 "名称标识符" 声明。 SignalR 使用声明来确定用户名。

添加一个实现 IUserIdProvider 的新类，并从用户中检索一个声明以用作标识符。例如，若要使用 "名称" 声明（[Domain][Username]格式的 Windows 用户名），请创建以下类：

  1. public class NameUserIdProvider : IUserIdProvider
  2. {
  3.     public string GetUserId(HubConnectionContext connection)
  4.     {
  5.         return connection.User?.Identity?.Name;
  6.     }
  7. }

你可以使用 User 中的任何值（例如 Windows SID 标识符，等等），而不是 ClaimTypes.Name。

备注

您选择的值在系统中的所有用户中必须是唯一的。否则，用于一个用户的消息可能最终会转到其他用户。

在 Startup.ConfigureServices 方法中注册此组件。

  1. public void ConfigureServices(IServiceCollection services)
  2. {
  3.     // ... other services ...
  5.     services.AddSignalR();
  6.     services.AddSingleton<IUserIdProvider, NameUserIdProvider>();
  7. }

在 .NET 客户端中，必须通过设置UseDefaultCredentials属性来启用 Windows 身份验证：

  1. var connection = new HubConnectionBuilder()
  2.     .WithUrl("https://example.com/myhub", options =>
  3.     {
  4.         options.UseDefaultCredentials = true;
  5.     })
  6.     .Build();

使用 Microsoft Internet Explorer 或 Microsoft Edge 时，浏览器客户端仅支持 Windows 身份验证。

使用声明自定义标识处理Use claims to customize identity handling

对用户进行身份验证的应用可以从用户声明派生 SignalR 用户 Id。若要指定 SignalR 如何创建用户 Id，请实现 IUserIdProvider 并注册实现。

示例代码演示了如何使用声明选择用户的电子邮件地址作为识别属性。

备注

您选择的值在系统中的所有用户中必须是唯一的。否则，用于一个用户的消息可能最终会转到其他用户。

  1. public class EmailBasedUserIdProvider : IUserIdProvider
  2. {
  3.     public virtual string GetUserId(HubConnectionContext connection)
  4.     {
  5.         return connection.User?.FindFirst(ClaimTypes.Email)?.Value;
  6.     }
  7. }

帐户注册将 ClaimsTypes.Email 类型的声明添加到 ASP.NET 标识数据库。

  1. // create a new user
  2. var user = new ApplicationUser { UserName = Input.Email, Email = Input.Email };
  3. var result = await _userManager.CreateAsync(user, Input.Password);
  5. // add the email claim and value for this user
  6. await _userManager.AddClaimAsync(user, new Claim(ClaimTypes.Email, Input.Email));

在 Startup.ConfigureServices中注册此组件。

  1. services.AddSingleton<IUserIdProvider, EmailBasedUserIdProvider>();

授权用户访问集线器和集线器方法Authorize users to access hubs and hub methods

默认情况下，集线器中的所有方法都可由未经身份验证的用户调用。若要要求身份验证，请将授权属性应用于中心：

  1. [Authorize]
  2. public class ChatHub: Hub
  3. {
  4. }

您可以使用 [Authorize] 属性的构造函数参数和属性，将访问权限限制为仅匹配特定授权策略的用户。例如，如果你有一个名为的自定义授权策略 MyAuthorizationPolicy 你可以确保只有符合该策略的用户可以使用以下代码访问该中心：

  1. [Authorize("MyAuthorizationPolicy")]
  2. public class ChatHub : Hub
  3. {
  4. }

单个集线器方法也可以应用 [Authorize] 特性。如果当前用户与应用于方法的策略不匹配，则会向调用方返回错误：

  1. [Authorize]
  2. public class ChatHub : Hub
  3. {
  4.     public async Task Send(string message)
  5.     {
  6.         // ... send a message to all users ...
  7.     }
  9.     [Authorize("Administrators")]
  10.     public void BanUser(string userName)
  11.     {
  12.         // ... ban a user from the chat room (something only Administrators can do) ...
  13.     }
  14. }

使用授权处理程序自定义集线器方法授权Use authorization handlers to customize hub method authorization

当集线器方法要求授权时，SignalR 向授权处理程序提供自定义资源。资源是 HubInvocationContext 的一个实例。HubInvocationContext 包括 HubCallerContext、正在调用的集线器方法的名称，以及中心方法的参数。

请考虑允许通过 Azure Active Directory 多个组织登录的聊天室的示例。拥有 Microsoft 帐户的任何人都可以登录到聊天，但只有拥有组织的成员才能阻止用户或查看用户的聊天历史记录。而且，我们可能希望限制某些用户的某些功能。使用 ASP.NET Core 3.0 中的更新功能，这是完全可能的。请注意 DomainRestrictedRequirement 如何作为自定义 IAuthorizationRequirement。既然正在传入 HubInvocationContext 资源参数，内部逻辑就可以检查正在调用中心的上下文，并决定是否允许用户执行单个集线器方法。

  1. [Authorize]
  2. public class ChatHub : Hub
  3. {
  4.     public void SendMessage(string message)
  5.     {
  6.     }
  8.     [Authorize("DomainRestricted")]
  9.     public void BanUser(string username)
  10.     {
  11.     }
  13.     [Authorize("DomainRestricted")]
  14.     public void ViewUserHistory(string username)
  15.     {
  16.     }
  17. }
  19. public class DomainRestrictedRequirement : 
  20.     AuthorizationHandler<DomainRestrictedRequirement, HubInvocationContext>, 
  21.     IAuthorizationRequirement
  22. {
  23.     protected override Task HandleRequirementAsync(AuthorizationHandlerContext context,
  24.         DomainRestrictedRequirement requirement, 
  25.         HubInvocationContext resource)
  26.     {
  27.         if (IsUserAllowedToDoThis(resource.HubMethodName, context.User.Identity.Name) && 
  28.             context.User.Identity.Name.EndsWith("@microsoft.com"))
  29.         {
  30.             context.Succeed(requirement);
  31.         }
  32.         return Task.CompletedTask;
  33.     }
  35.     private bool IsUserAllowedToDoThis(string hubMethodName,
  36.         string currentUsername)
  37.     {
  38.         return !(currentUsername.Equals("asdf42@microsoft.com") && 
  39.             hubMethodName.Equals("banUser", StringComparison.OrdinalIgnoreCase));
  40.     }
  41. }

在 Startup.ConfigureServices中，添加新策略，并提供自定义 DomainRestrictedRequirement 要求作为参数，以创建 DomainRestricted 策略。

  1. public void ConfigureServices(IServiceCollection services)
  2. {
  3.     // ... other services ...
  5.     services
  6.         .AddAuthorization(options =>
  7.         {
  8.             options.AddPolicy("DomainRestricted", policy =>
  9.             {
  10.                 policy.Requirements.Add(new DomainRestrictedRequirement());
  11.             });
  12.         });
  13. }

在前面的示例中，DomainRestrictedRequirement 类既是 IAuthorizationRequirement 又是该要求的 AuthorizationHandler。可以将这两个组件拆分为单独的类，以分隔问题。该示例方法的优点是，无需在启动过程中注入 AuthorizationHandler，因为要求和处理程序是相同的。

其他资源Additional resources