C#-claims（声明）

本文主要是介绍C#-claims（声明），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

前言
一、claims
二、使用步骤
三、claims结合JWT使用
- - 场景
  - 用户登录流程
  - 用户购买书籍
  - 代码示例

前言

C#学习系列，Claims可以在身份验证过程中被创建和分配给用户，然后在应用程序中用于授权和决策。

一、claims

在C#中，特别是在.NET框架的身份验证和授权上下文中，“claims”（声明）指的是关于用户或主体的可验证的信息片段。这些声明可以包括用户的身份信息、权限、角色等。它们通常用于构建基于声明的身份验证系统，允许开发者对用户进行细粒度的授权管理。

在.NET中，声明通常以System.Security.Claims.Claim对象的形式存在。一个Claim对象包含三个主要的属性：

Issuer（发行者）：声明的发行者，通常是认证机构或服务，它创建并发行了该声明。

OriginalIssuer（原始发行者）：如果声明经过了转换或传递，这个属性表示原始的发行者。

Values（值）：包含声明的实际信息，可以有多个值，它们是键值对的形式，其中键是声明的类型

二、使用步骤

以下是一个示例，展示了如何创建和使用claims：

// 创建一个声明集合
var claims = new List<Claim>
{new Claim(ClaimTypes.Name, "Alice"),new Claim(ClaimTypes.Role, "Admin"),new Claim("Permission", "EditArticles")
};// 创建一个身份验证令牌并将claims添加到其中
var identity = new ClaimsIdentity(claims, "Token");// 创建一个主体
var principal = new ClaimsPrincipal(identity);// 在应用程序中检查用户是否具有特定权限
var hasPermission = principal.HasClaim("Permission", "EditArticles");

在.NET Core和ASP.NET Core中，声明的使用非常广泛，特别是在使用JWT（JSON Web Tokens）进行身份验证时。JWT可以包含一组声明，这些声明在用户登录后被生成，并在后续的请求中用于验证用户的身份和授权决策。

例如，当用户登录成功后，身份验证服务可能会生成一个包含用户ID、姓名、角色等信息的JWT，并将其发送给客户端。客户端随后在每个请求中携带这个JWT，服务器端可以验证JWT并提取其中的声明信息，以确定用户是否有权访问特定的资源或执行特定的操作。

三、claims结合JWT使用

场景

假设我们有一个在线书店，它提供了一个API供用户购买书籍。为了保护API，我们需要验证用户的身份，并确保只有登录的用户才能访问购买书籍的端点。

用户登录流程

用户提交凭据：用户通过登录界面提交用户名和密码。
验证凭据：后端服务验证用户名和密码的正确性。如果凭据正确，服务将创建一个包含用户信息的JWT。
生成JWT：JWT中包含用户的claims，例如用户ID、用户名、角色（如"customer"或"admin"）等。这些claims将被编码到JWT的载荷（Payload）部分。
签名JWT：为了确保JWT的安全性，服务使用私钥对JWT进行签名。
返回JWT给用户：登录成功后，服务将JWT作为响应返回给用户。

用户购买书籍

发送请求：用户选择书籍后，通过客户端（如Web浏览器或移动应用）发送购买请求到API。
携带JWT：请求中包含一个Authorization头部，其中包含之前获取的JWT。
验证JWT：API接收到请求后，首先验证JWT的签名以确保其有效性。如果签名验证失败，API将拒绝请求。
提取claims：API解码JWT并提取其中的claims。根据claims中的信息，API执行相应的授权检查，例如确保用户的角色是"customer"。
处理请求：如果用户有权访问，API处理购买请求，更新库存，并返回购买确认信息给用户。

代码示例

以下是使用C#和ASP.NET Core的一个简化代码示例：

// 登录服务中生成JWT
var claims = new[]
{new Claim(ClaimTypes.NameIdentifier, userId),new Claim(ClaimTypes.Name, username),new Claim("role", userRole)
};var signingKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secretKey));
var credentials = new SigningCredentials(signingKey, SecurityAlgorithms.HmacSha256);var token = new JwtSecurityToken(issuer: "http://localhost:5000",audience: "http://localhost:5000/api",claims: claims,expires: DateTime.Now.AddMinutes(30),signingCredentials: credentials);// 返回JWT给用户
return new OkObjectResult(new { token });// API端点中验证JWT
[HttpGet("books/buy")]
public IActionResult BuyBook([FromHeader] string authorization)
{var identity = (ClaimsIdentity)User.Identity;if (!identity.HasClaim(c => c.Type == "role" && c.Value == "customer")){return Forbid();}// 处理购买逻辑...return Ok();
}