Easy-DotNET Easy-DotNET
🏠首页
  • 知识地图
  • 源码脑图

    • 总览
    • Program
    • WebApplication
    • Host主机
    • WebHost主机
    • 依赖注入
    • Autofac
    • Middleware中间件
    • RateLimiter限制速率
    • 响应缓存、请求解压缩
  • 设计初衷
  • 克隆
  • 类型转换
  • 日期时间
  • IO流
  • 工具类
  • 语言特性
  • 集合类
  • Codec编码
  • 文本操作
  • 数学
  • 图片
  • 网络
  • Emoji表情
  • C# 12
  • C# 11
  • C# 10
  • C# 9.0
  • C# 8.0
  • C# 早期版本
  • C# 教程
  • ORM
  • 定时任务
  • 日志
  • 认证与授权
  • Swagger
  • 对象映射
  • 熔断重试限流
  • 缓存
  • 注册发现
  • 网关
  • GraphQL
  • 更多
  • Docker

    • 简介
    • Adminer
    • Apisix
    • Apollo
    • Cassandra
    • Cerebro
    • ClickHouse
    • Consul
    • EasyMock
    • Elasticsearch
    • Emqx
    • FastDFS
    • Flink
    • Gitlab
    • Jenkins
    • Jrebel
    • MariaDB
    • MySQL
    • Percona
    • Phpmyadmin
    • PostgreSQL
    • Redis
  • Linux

    • 查看Linux系统信息
    • CentOS7调整磁盘分区
    • IO压测
    • 图形化监控工具Cockpit
  • 总览
  • 列表

    • 算法数据结构
    • API
    • 应用框架
    • 应用模板
    • 操作系统
    • 工作流
    • 入门套件
    • 示例
    • 人工智能
    • 程序集
    • Assets
    • 认证授权
    • Blazor
    • 区块链
    • 书籍
    • 自动构建
    • 报表
    • 缓存
    • 日历
    • 聊天
    • CLI
    • CLR
    • CMS
    • 代码分析和指标
    • 代码片段
    • 压缩
    • 持续集成
    • 密码学
    • 数据库
    • 数据库驱动
    • 日期时间
    • 反编译
    • 部署
    • DirectX
    • 分布式计算
    • DLR
    • 文档
    • 电商支付
    • 模拟器
    • 环境管理
    • ETL
    • 事件消息
    • Exception
    • 扩展
    • 函数式编程
    • 游戏引擎
    • GIS
    • Git工具
    • 绘图
    • GraphQL
    • GUI
    • HTML-CSS
    • HTTP
    • IDE
    • 图片处理
    • 安装工具
    • 交互式编程
    • 国际化
    • 互操作性
    • IoC
    • JS引擎
    • 日志
    • 机器学习和数据科学
    • Markdown
    • 邮件
    • 数学
    • 媒体
    • 指标
    • 微型框架
    • 最小化器
    • MVVM
    • 网络
    • 对象映射
    • Office
    • OpenAI
    • ORM
    • 包管理器
    • PDF
    • 性能分析工具
    • 协议
    • 推送通知
    • SQL构建器
    • 消息队列
    • RPC
    • 响应式编程
    • 实时通信
    • 正则表达式
    • 任务调度
    • SDK和API
    • 搜索引擎
    • 序列化
    • SMS
    • 状态机
    • 静态站点生成
    • 强命名
    • 风格指南
    • 模板引擎
    • 测试
    • 工具
    • 交易
    • UI自动测试
    • Visual Studio 插件
    • Web浏览器
    • Web框架
    • WebServers
    • WebSocket
    • Windows服务
    • WPF
    • 解析器
    • 源码生成
    • 其他
    • 资源
  • AspNetCore面试题
  • Elasticsearch面试题
  • MongoDB面试题
  • MySql面试题
  • Nginx面试题
  • RabbitMQ面试题
  • Redis面试题
  • 设计模式
  • 微服务
🧑‍💻.NET Blog
GitHub (opens new window)
🏠首页
  • 知识地图
  • 源码脑图

    • 总览
    • Program
    • WebApplication
    • Host主机
    • WebHost主机
    • 依赖注入
    • Autofac
    • Middleware中间件
    • RateLimiter限制速率
    • 响应缓存、请求解压缩
  • 设计初衷
  • 克隆
  • 类型转换
  • 日期时间
  • IO流
  • 工具类
  • 语言特性
  • 集合类
  • Codec编码
  • 文本操作
  • 数学
  • 图片
  • 网络
  • Emoji表情
  • C# 12
  • C# 11
  • C# 10
  • C# 9.0
  • C# 8.0
  • C# 早期版本
  • C# 教程
  • ORM
  • 定时任务
  • 日志
  • 认证与授权
  • Swagger
  • 对象映射
  • 熔断重试限流
  • 缓存
  • 注册发现
  • 网关
  • GraphQL
  • 更多
  • Docker

    • 简介
    • Adminer
    • Apisix
    • Apollo
    • Cassandra
    • Cerebro
    • ClickHouse
    • Consul
    • EasyMock
    • Elasticsearch
    • Emqx
    • FastDFS
    • Flink
    • Gitlab
    • Jenkins
    • Jrebel
    • MariaDB
    • MySQL
    • Percona
    • Phpmyadmin
    • PostgreSQL
    • Redis
  • Linux

    • 查看Linux系统信息
    • CentOS7调整磁盘分区
    • IO压测
    • 图形化监控工具Cockpit
  • 总览
  • 列表

    • 算法数据结构
    • API
    • 应用框架
    • 应用模板
    • 操作系统
    • 工作流
    • 入门套件
    • 示例
    • 人工智能
    • 程序集
    • Assets
    • 认证授权
    • Blazor
    • 区块链
    • 书籍
    • 自动构建
    • 报表
    • 缓存
    • 日历
    • 聊天
    • CLI
    • CLR
    • CMS
    • 代码分析和指标
    • 代码片段
    • 压缩
    • 持续集成
    • 密码学
    • 数据库
    • 数据库驱动
    • 日期时间
    • 反编译
    • 部署
    • DirectX
    • 分布式计算
    • DLR
    • 文档
    • 电商支付
    • 模拟器
    • 环境管理
    • ETL
    • 事件消息
    • Exception
    • 扩展
    • 函数式编程
    • 游戏引擎
    • GIS
    • Git工具
    • 绘图
    • GraphQL
    • GUI
    • HTML-CSS
    • HTTP
    • IDE
    • 图片处理
    • 安装工具
    • 交互式编程
    • 国际化
    • 互操作性
    • IoC
    • JS引擎
    • 日志
    • 机器学习和数据科学
    • Markdown
    • 邮件
    • 数学
    • 媒体
    • 指标
    • 微型框架
    • 最小化器
    • MVVM
    • 网络
    • 对象映射
    • Office
    • OpenAI
    • ORM
    • 包管理器
    • PDF
    • 性能分析工具
    • 协议
    • 推送通知
    • SQL构建器
    • 消息队列
    • RPC
    • 响应式编程
    • 实时通信
    • 正则表达式
    • 任务调度
    • SDK和API
    • 搜索引擎
    • 序列化
    • SMS
    • 状态机
    • 静态站点生成
    • 强命名
    • 风格指南
    • 模板引擎
    • 测试
    • 工具
    • 交易
    • UI自动测试
    • Visual Studio 插件
    • Web浏览器
    • Web框架
    • WebServers
    • WebSocket
    • Windows服务
    • WPF
    • 解析器
    • 源码生成
    • 其他
    • 资源
  • AspNetCore面试题
  • Elasticsearch面试题
  • MongoDB面试题
  • MySql面试题
  • Nginx面试题
  • RabbitMQ面试题
  • Redis面试题
  • 设计模式
  • 微服务
🧑‍💻.NET Blog
GitHub (opens new window)
npm
  • 简介
  • ORM

    • EFCore
    • Dapper
    • FreeSql
    • SqlSugar
  • 任务调度

    • Hangfire
    • Quartz
    • FluentScheduler
    • Coravel
    • Quartzmin
  • 日志

    • Serilog
    • NLog
    • Log4Net
    • Stackdriver
    • ExceptionLess
  • 身份认证与授权

    • IdentityServer4
    • Identity
    • JWTBearer
      • 如何实现JWTBearer框架?
        • 步骤1:安装必要的包
        • 步骤2:配置身份验证服务
        • 步骤3:配置授权策略
        • 步骤4:启用身份验证和授权
      • JWTBearer框架的使用示例
        • 步骤1:创建API
        • 步骤2:添加身份验证和授权支持
        • 步骤3:添加API控制器
        • 步骤4:生成JWT令牌
        • 步骤5:使用JWT令牌进行身份验证
      • 结论
    • Auth0
    • OpenIddict
  • Swagger文档

    • Swagger
    • Swashbuckle
    • NSwag
    • ReDoc
  • 对象映射

    • AutoMapper
    • EmitMapper
    • AgileMapper
    • Mapster
  • 消息传递

    • MediatR
    • MassTransit
    • Rebus
    • NServiceBus
  • 熔断重试限流

    • Polly
    • Resilience4j
    • AkkaNET
  • 缓存

    • CsRedis
    • FreeRedis
    • EasyCaching
    • StackExchangeRedis
    • CacheCow
    • NCache
    • Memory
  • 注册发现

    • Consul
    • Nacos
    • Apollo
  • 网关

    • Ocelot
    • Kong
    • Traefik
    • Zuul
  • GraphQL

    • GraphQLPlatform
    • GraphQLdotnet
  • 更多

    • NodaTime
    • FluentAssertions
    • Humanizer
    • 爬虫-AngleSharp
    • 邮件-MailKit
  • NET微服务
  • 身份认证与授权
一个大西瓜
2023-04-20
目录

JWTBearer

开源地址

Github:https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/tree/master/src/System.IdentityModel.Tokens.Jwt (opens new window)

JWTBearer框架是.NET中一种基于JSON Web Token (JWT)实现的身份验证和授权框架。JWT是一种开放标准,用于在不同系统之间安全地传输信息。它使用JSON对象来表示声明,声明包含关于实体(通常是用户)的信息以及与该实体相关的元数据。这些声明可以被签名和/或加密,以确保只有授权用户可以访问它们。

JWTBearer框架建立在ASP.NET Core中的身份验证和授权机制之上。它使用JWT作为身份验证令牌,当用户成功验证后,它会将该令牌放置在请求标头中。这个标头可以被中间件检索并用于授权请求。

# 如何实现JWTBearer框架?

要在.NET应用程序中实现JWTBearer框架,需要执行以下步骤:

# 步骤1:安装必要的包

在.NET应用程序中使用JWTBearer框架需要安装以下两个NuGet包:

  • Microsoft.AspNetCore.Authentication.JwtBearer
  • System.IdentityModel.Tokens.Jwt

可以使用Visual Studio的NuGet包管理器或在终端窗口中使用以下命令来安装这些包:


Install-Package Microsoft.AspNetCore.Authentication.JwtBearer
Install-Package System.IdentityModel.Tokens.Jwt

# 步骤2:配置身份验证服务

在.NET应用程序的Startup.cs文件中,需要添加身份验证服务的配置。这可以通过调用AddAuthentication方法并传递一个AuthenticationScheme对象来完成。在JWTBearer框架中,可以使用JwtBearerDefaults.AuthenticationScheme来表示此方案。在配置过程中,需要提供JWT的发行者、受众者、密钥等信息。


using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;

public void ConfigureServices(IServiceCollection services)
{
    services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
        .AddJwtBearer(options =>
        {
            options.TokenValidationParameters = new TokenValidationParameters
            {
                ValidateIssuer = true,
                ValidateAudience = true,
                ValidateLifetime = true,
                ValidateIssuerSigningKey = true,
                ValidIssuer = "your-issuer",
                ValidAudience = "your-audience",
                IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("your-secret-key"))
            };
        });
}

# 步骤3:配置授权策略

在.NET应用程序中,授权策略用于定义哪些用户可以访问哪些资源。在JWTBearer框架中,可以使用RequireAuthenticatedUser()方法来指定只有授权用户才能访问资源。


using Microsoft.AspNetCore.Authorization;

public void ConfigureServices(IServiceCollection services)
{
    // 配置身份验证服务
    services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
        .AddJwtBearer(options =>
        {
            // 省略配置代码
        });

    // 配置授权策略
    services.AddAuthorization(options =>
    {
        options.DefaultPolicy = new AuthorizationPolicyBuilder()
            .RequireAuthenticatedUser()
            .Build();
    });
}

# 步骤4:启用身份验证和授权

在.NET应用程序中,需要调用UseAuthentication()方法来启用身份验证中间件,调用UseAuthorization()方法来启用授权中间件。


public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 省略其他配置代码

    // 启用身份验证和授权中间件
    app.UseAuthentication();
    app.UseAuthorization();
}

# JWTBearer框架的使用示例

在.NET应用程序中使用JWTBearer框架的基本步骤已经介绍完毕。接下来,我们将使用一个具体的示例来演示如何实现身份验证和授权。

假设我们正在开发一个API,用于管理用户的订单。我们希望只有授权用户才能访问该API。我们将使用JWTBearer框架来实现此功能。

# 步骤1:创建API

首先,我们需要创建一个API,用于管理用户的订单。我们可以使用ASP.NET Core Web API模板来创建此API。在Visual Studio中,选择"ASP.NET Core Web应用程序"项目模板,选择"API"模板,并输入项目名称和位置。

# 步骤2:添加身份验证和授权支持

接下来,我们需要添加身份验证和授权支持。在我们的API项目的Startup.cs文件中,我们将添加以下代码:


using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.AspNetCore.Authorization;
using Microsoft.IdentityModel.Tokens;

public void ConfigureServices(IServiceCollection services)
{
    // 配置身份验证服务
    services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
        .AddJwtBearer(options =>
        {
            options.TokenValidationParameters = new TokenValidationParameters
            {
                ValidateIssuer = true,
                ValidateAudience = true,
                ValidateLifetime = true,
                ValidateIssuerSigningKey = true,
                ValidIssuer = "your-issuer",
                ValidAudience = "your-audience",
                IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("your-secret-key"))
            };
        });

    // 配置授权策略
    services.AddAuthorization(options =>
    {
        options.DefaultPolicy = new AuthorizationPolicyBuilder()
            .RequireAuthenticatedUser()
            .Build();
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 省略其他配置代码

    // 启用身份验证和授权中间件
    app.UseAuthentication();
    app.UseAuthorization();
}

这将添加JWTBearer框架的身份验证和授权支持。我们将使用"your-issuer"、"your-audience"和"your-secret-key"作为示例值,实际应用程序中需要使用自己的值。

# 步骤3:添加API控制器

接下来,我们需要添加API控制器。在我们的API项目中,我们将添加一个名为"OrdersController"的控制器。此控制器将包含管理订单的API操作。


using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
[Authorize]
public class OrdersController : ControllerBase
{
    [HttpGet]
    public IActionResult Get()
    {
        // 返回所有订单
        return Ok("All Orders");
    }

    [HttpGet("{id}")]
    public IActionResult GetById(int id)
    {
        // 根据订单ID返回订单
        return Ok($"Order {id}");
    }

    [HttpPost]
    public IActionResult Post()
    {
        // 创建新订单
        return Ok("New Order Created");
    }

    [HttpPut("{id}")]
    public IActionResult Put(int id)
    {
        // 更新订单
        return Ok($"Order {id} Updated");
    }

    [HttpDelete("{id}")]
    public IActionResult Delete(int id)
    {
        // 删除订单
        return Ok($"Order {id} Deleted");
    }
}

注意,我们在"OrdersController"类上添加了Authorize属性。这意味着只有授权用户才能访问"OrdersController"中的API操作。

# 步骤4:生成JWT令牌

现在,我们需要生成一个JWT令牌,并将其用于身份验证。我们将使用Microsoft.IdentityModel.Tokens库中的JwtSecurityToken类来生成JWT令牌。


using System;
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;
using System.Text;
using Microsoft.IdentityModel.Tokens;

public string GenerateJwtToken(string userId, string username, string secretKey, string issuer, string audience, int expirationMinutes = 60)
{
    // 创建声明
    var claims = new[]
    {
        new Claim(JwtRegisteredClaimNames.Sub, userId),
        new Claim(JwtRegisteredClaimNames.UniqueName, username),
        new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString())
    };

    // 创建密钥
    var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secretKey));

    // 创建凭证
    var credentials = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);

    // 创建JWT令牌
    var token = new JwtSecurityToken(
        issuer: issuer,
        audience: audience,
        claims: claims,
        expires: DateTime.UtcNow.AddMinutes(expirationMinutes),
        signingCredentials: credentials);

    // 序列化JWT令牌
    var encodedToken = new JwtSecurityTokenHandler().WriteToken(token);

    return encodedToken;
}

在这个方法中,我们需要传递userId、username、secretKey、issuer、audience和expirationMinutes参数。userId和username将包含在JWT令牌的声明中。secretKey将用于签署JWT令牌。issuer和audience将用于验证JWT令牌。expirationMinutes将指定JWT令牌的有效期。

# 步骤5:使用JWT令牌进行身份验证

现在,我们可以使用上一步中生成的JWT令牌进行身份验证。我们可以使用HTTP客户端发送一个带有Authorization标头的请求,其中包含JWT令牌。

以下是一个使用C# HttpClient类进行身份验证的示例:


using System;
using System.Net.Http;
using System.Threading.Tasks;

public async Task<string> CallApi(string token)
{
    using (var client = new HttpClient())
    {
        // 添加Authorization标头
        client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", token);

        // 发送请求
        var response = await client.GetAsync("https://your-api.com/orders");

        // 检查响应状态码
        if (response.IsSuccessStatusCode)
        {
            var content = await response.Content.ReadAsStringAsync();
            return content;
        }
        else
        {
            return null;
        }
    }
}

在这个方法中,我们需要传递一个JWT令牌作为参数。我们将在Authorization标头中包含此JWT令牌,并使用HttpClient类发送请求。

如果JWT令牌有效且包含正确的声明,我们的API将返回请求的资源。否则,API将返回401未经授权的响应。

# 结论

JWTBearer框架是.NET中一种流行的身份验证和授权框架。它基于JSON Web Token,可以安全地传输声明和元数据。使用JWTBearer框架,开发人员可以轻松实现身份验证和授权,并确保只有授权用户才能访问应用程序的特定资源。

本文介绍了如何在.NET应用程序中使用JWTBearer框架实现身份验证和授权。我们还提供了一个使用示例,演示如何创建API、配置身份验证和授权、生成JWT令牌以及使用JWT令牌进行身份验证。

希望本文可以帮助.NET开发人员更好地理解JWTBearer框架,并在实际应用程序中使用它来实现身份验证和授权。

上次更新: 2023/04/26, 22:10:06
Identity
Auth0

← Identity Auth0→

Theme by Vdoing | Copyright © 2019-2024 一个大西瓜 | MIT License | 苏ICP备2023013501号
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式