ASP.NET Core 实现基于 ApiKey 的认证

2023-11-05 19:18
文章标签 实现 认证 core asp net apikey

本文主要是介绍ASP.NET Core 实现基于 ApiKey 的认证,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

ASP.NET Core 实现基于 ApiKey 的认证

Intro

之前我们有介绍过实现基于请求头的认证,今天来实现一个基于 ApiKey 的认证方式,使用方式参见下面的示例

Sample

注册认证服务

services.AddAuthentication().AddApiKey(options =>{options.ApiKey = "123456";options.ApiKeyName = "X-ApiKey";});

可以根据需要是否要指定为默认的认证 Schema

控制器示例代码:

[HttpGet("apiKeyTest")]
[Authorize(AuthenticationSchemes = ApiKeyAuthenticationDefaults.AuthenticationSchema)]
public IActionResult ApiKeyAuthTest()
{return Ok(User.Identity);
}

因为我们没有指定为默认的认证 Schema,所以在这个 Action 上我们指定了希望使用的认证方式

调用示例:

直接调用不使用 ApiKey

df05984a12a56ef0776c98767fcf8cba.png

使用错误的 ApiKey

bf98f2eff1731f81309feca87ba4a2ce.png

使用正确的 ApiKey

0aafb15ce4fe32b5cf62d49f9df76159.png

从上面的结果可以看出来只有在 ApiKey 是正确的情况下才能正常调用 Api

Implement

对于自定义认证方式我们之前也有介绍过基于请求头的认证方式,基于 ApiKey 的认证和请求头也类似,

对于自定义认证方式,核心需要定义的有两个类型

  • 一个是认证选项,自定义的 AuthenticationOption

  • 一个是认证处理器,自定义的认证处理逻辑

下面来看实现

ApiKeyAuthenticationOptions

实现如下:

public sealed class ApiKeyAuthenticationOptions : AuthenticationSchemeOptions
{public string ApiKey { get; set; }public string ApiKeyName { get; set; } = "X-ApiKey";public string ClientId { get; set; }public KeyLocation KeyLocation { get; set; }public override void Validate(){if (string.IsNullOrWhiteSpace(ApiKey)){throw new ArgumentException("Invalid ApiKey configured");}}
}public enum KeyLocation
{Header = 0,Query = 1,HeaderOrQuery = 2,QueryOrHeader = 3,
}

继承于 AuthenticationSchemeOptions 并添加认证所需的配置,我们增加了一个 KeyLocation 以配置读取 ApiKey 的来源,Header 就是从请求头去读,Query 就是从查询字符串读取,HeaderOrQuery 就是优先读取 Header,对应的 QueryOrHeader 就是优先读取查询字符串

另外我们可以重载 Validate 方法来对我们的配置进行校验

ApiKeyAuthenticationHandler

认证处理器是认证方式的核心处理逻辑,我们的处理也比较简单,就是直接读取 ApiKey 与配置的 ApiKey 对比,一致就认证成功,否则就是非法请求,实现如下:

public sealed class ApiKeyAuthenticationHandler : AuthenticationHandler<ApiKeyAuthenticationOptions>
{public ApiKeyAuthenticationHandler(IOptionsMonitor<ApiKeyAuthenticationOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock) : base(options, logger, encoder, clock){}protected override Task<AuthenticateResult> HandleAuthenticateAsync(){var authResult = HandleAuthenticateInternal();return Task.FromResult(authResult);}private AuthenticateResult HandleAuthenticateInternal(){StringValues keyValues;var keyExists = Options.KeyLocation switch{KeyLocation.Query => Request.Query.TryGetValue(Options.ApiKeyName, out keyValues),KeyLocation.HeaderOrQuery => Request.Headers.TryGetValue(Options.ApiKeyName, out keyValues) || Request.Query.TryGetValue(Options.ApiKeyName, out keyValues),KeyLocation.QueryOrHeader => Request.Query.TryGetValue(Options.ApiKeyName, out keyValues) || Request.Headers.TryGetValue(Options.ApiKeyName, out keyValues),_ => Request.Headers.TryGetValue(Options.ApiKeyName, out keyValues),};if (!keyExists)return AuthenticateResult.NoResult();if (keyValues.ToString().Equals(Options.ApiKey)){var clientId = Options.ClientId.GetValueOrDefault(ApplicationHelper.ApplicationName);return AuthenticateResult.Success(new AuthenticationTicket(new ClaimsPrincipal(new[]{new ClaimsIdentity(new[]{new Claim(nameof(Options.ClientId), clientId, ClaimValueTypes.String, ClaimsIssuer),}, Scheme.Name)}), Scheme.Name));}return AuthenticateResult.Fail("Invalid Api-Key");}
}

Extensions

为了方便使用添加了几个常用的扩展方法,类似于 ASP.NET Core 自带的认证方式

首先增加了一个默认的认证模式

public static class ApiKeyAuthenticationDefaults
{public const string AuthenticationSchema = "ApiKey";
}

然后增加了一些依赖注入的扩展

public static AuthenticationBuilder AddApiKey(this AuthenticationBuilder builder)
{return builder.AddApiKey(ApiKeyAuthenticationDefaults.AuthenticationSchema);
}public static AuthenticationBuilder AddApiKey(this AuthenticationBuilder builder, string schema)
{return builder.AddApiKey(schema, _ => { });
}public static AuthenticationBuilder AddApiKey(this AuthenticationBuilder builder,Action<ApiKeyAuthenticationOptions> configureOptions)
{return builder.AddApiKey(ApiKeyAuthenticationDefaults.AuthenticationSchema,configureOptions);
}public static AuthenticationBuilder AddApiKey(this AuthenticationBuilder builder, string schema,Action<ApiKeyAuthenticationOptions> configureOptions)
{if (null != configureOptions){builder.Services.Configure(configureOptions);}return builder.AddScheme<ApiKeyAuthenticationOptions, ApiKeyAuthenticationHandler>(schema,configureOptions);
}

More

目前的实现比较简单,只是对 ApiKey 做了校验,而且是直接读取的配置,大家可以根据自己需要进行一定的扩展,比如 ApiKey 从数据库中读取、增加额外的 claim 配置等。

对于一些需要配置客户端访问权限的可以使用这种方式来实现简单的认证来代替基于 OAuth 的 Client Credentials 方式,相对来说会简单一些

References

  • https://github.com/WeihanLi/WeihanLi.Web.Extensions/blob/dev/src/WeihanLi.Web.Extensions/Authentication/ApiKeyAuthentication/ApiKeyAuthenticationHandler.cs

  • https://github.com/WeihanLi/WeihanLi.Web.Extensions/blob/dev/samples/WeihanLi.Web.Extensions.Samples/Program.cs

  • asp.net core 自定义认证方式--请求头认证

这篇关于ASP.NET Core 实现基于 ApiKey 的认证的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/351943

相关文章

c++ 类成员变量默认初始值的实现

《c++类成员变量默认初始值的实现》本文主要介绍了c++类成员变量默认初始值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录C++类成员变量初始化c++类的变量的初始化在C++中,如果使用类成员变量时未给定其初始值,那么它将被

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

在Linux中改变echo输出颜色的实现方法

《在Linux中改变echo输出颜色的实现方法》在Linux系统的命令行环境下,为了使输出信息更加清晰、突出,便于用户快速识别和区分不同类型的信息,常常需要改变echo命令的输出颜色,所以本文给大家介... 目python录在linux中改变echo输出颜色的方法技术背景实现步骤使用ANSI转义码使用tpu

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

golang版本升级如何实现

《golang版本升级如何实现》:本文主要介绍golang版本升级如何实现问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录golanwww.chinasem.cng版本升级linux上golang版本升级删除golang旧版本安装golang最新版本总结gola

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具