1. Python技术站首页
  2. 其他
  3. C#

手把手教你AspNetCore WebApi认证与授权的方法

• C#

手把手教你AspNetCore WebApi认证与授权的方法

在ASP.NET Core WebApi中，认证和授权是非常重要的安全措施。在本攻略中，我们将介绍如何在ASP.NET Core WebApi中实现认证和授权，并提供两个示例说明。

步骤一：添加认证和授权中间件

首先，需要在ASP.NET Core WebApi中添加认证和授权中间件。可以使用以下命令将Microsoft.AspNetCore.Authentication和Microsoft.AspNetCore.Authorization包添加到项目中：

dotnet add package Microsoft.AspNetCore.Authentication
dotnet add package Microsoft.AspNetCore.Authorization

在“Startup.cs”文件中，添加以下代码：

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.IdentityModel.Tokens;
using System.Text;

namespace MyWebApi
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();

            services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
                .AddJwtBearer(options =>
                {
                    options.TokenValidationParameters = new TokenValidationParameters
                    {
                        ValidateIssuer = true,
                        ValidateAudience = true,
                        ValidateLifetime = true,
                        ValidateIssuerSigningKey = true,
                        ValidIssuer = "mydomain.com",
                        ValidAudience = "mydomain.com",
                        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("mysecretkey"))
                    };
                });

            services.AddAuthorization(options =>
            {
                options.AddPolicy("MyPolicy", policy =>
                {
                    policy.RequireAuthenticatedUser();
                    policy.RequireClaim("MyClaim");
                });
            });
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseAuthentication();

            app.UseMvc();
        }
    }
}

在上面的代码中，我们使用了JWT Bearer认证方案，并添加了一个名为“MyPolicy”的授权策略。我们还配置了JWT令牌的验证参数，包括颁发者、受众、签名密钥等。

步骤二：添加认证和授权特性

接下来，需要在ASP.NET Core WebApi中添加认证和授权特性。可以使用以下代码在控制器或操作方法上添加特性：

[Authorize(Policy = "MyPolicy")]
public class MyController : Controller
{
    [HttpGet]
    public IActionResult MyAction()
    {
        return Ok();
    }
}

在上面的代码中，我们使用了“Authorize”特性，并指定了“MyPolicy”授权策略。

示例一：使用JWT令牌认证和授权

以下是一个示例，演示如何使用JWT令牌认证和授权：

  1. 在命令行中，使用以下命令创建一个新的ASP.NET Core WebApi项目：
dotnet new webapi -n MyWebApi
  1. 在项目的根目录中，使用以下命令添加Microsoft.AspNetCore.Authentication和Microsoft.AspNetCore.Authorization包：
dotnet add package Microsoft.AspNetCore.Authentication
dotnet add package Microsoft.AspNetCore.Authorization
  1. 在“Startup.cs”文件中，添加以下代码：
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.IdentityModel.Tokens;
using System.Text;

namespace MyWebApi
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();

            services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
                .AddJwtBearer(options =>
                {
                    options.TokenValidationParameters = new TokenValidationParameters
                    {
                        ValidateIssuer = true,
                        ValidateAudience = true,
                        ValidateLifetime = true,
                        ValidateIssuerSigningKey = true,
                        ValidIssuer = "mydomain.com",
                        ValidAudience = "mydomain.com",
                        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("mysecretkey"))
                    };
                });

            services.AddAuthorization(options =>
            {
                options.AddPolicy("MyPolicy", policy =>
                {
                    policy.RequireAuthenticatedUser();
                    policy.RequireClaim("MyClaim");
                });
            });
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseAuthentication();

            app.UseMvc();
        }
    }
}

在上面的代码中，我们使用了JWT Bearer认证方案，并添加了一个名为“MyPolicy”的授权策略。我们还配置了JWT令牌的验证参数，包括颁发者、受众、签名密钥等。

  1. 在“Controllers”文件夹中，创建一个名为“MyController.cs”的文件，并添加以下代码：
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Authorize(Policy = "MyPolicy")]
    [Route("api/[controller]")]
    public class MyController : Controller
    {
        [HttpGet]
        public IActionResult MyAction()
        {
            return Ok();
        }
    }
}

在上面的代码中，我们使用了“Authorize”特性，并指定了“MyPolicy”授权策略。

  1. 在命令行中，使用以下命令运行应用程序：
dotnet run
  1. 在浏览器中，导航到“http://localhost:5000/api/my”。

  2. 应该看到401未经授权的错误。

  3. 在命令行中，使用以下命令生成JWT令牌：

dotnet add package System.IdentityModel.Tokens.Jwt

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

namespace MyWebApi
{
    public class JwtTokenGenerator
    {
        public static string GenerateToken()
        {
            var tokenHandler = new JwtSecurityTokenHandler();
            var key = Encoding.ASCII.GetBytes("mysecretkey");
            var tokenDescriptor = new SecurityTokenDescriptor
            {
                Subject = new ClaimsIdentity(new Claim[]
                {
                    new Claim(ClaimTypes.Name, "myusername"),
                    new Claim("MyClaim", "myvalue")
                }),
                Expires = DateTime.UtcNow.AddMinutes(5),
                SigningCredentials = new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature)
            };
            var token = tokenHandler.CreateToken(tokenDescriptor);
            return tokenHandler.WriteToken(token);
        }
    }
}

在上面的代码中，我们使用了JWT令牌生成器类，生成了一个包含用户名和自定义声明的JWT令牌。

  1. 在命令行中，使用以下命令获取JWT令牌：
dotnet run MyWebApi.dll

curl -X POST -H "Content-Type: application/json" -d '{"username":"myusername","password":"mypassword"}' http://localhost:5000/api/token

在上面的命令中，我们使用了curl命令向“/api/token”端点发送POST请求，以获取JWT令牌。

  1. 在命令行中，使用以下命令向“/api/my”端点发送GET请求，并在请求头中添加JWT令牌：
curl -H "Authorization: Bearer <jwt_token>" http://localhost:5000/api/my

在上面的命令中，我们使用了curl命令向“/api/my”端点发送GET请求，并在请求头中添加JWT令牌。

  1. 应该看到200成功的响应。

示例二：使用基本身份验证认证和授权

以下是一个示例，演示如何使用基本身份验证认证和授权：

  1. 在命令行中，使用以下命令创建一个新的ASP.NET Core WebApi项目：
dotnet new webapi -n MyWebApi
  1. 在“Startup.cs”文件中，添加以下代码：
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using System.Security.Claims;
using System.Text;
using System.Threading.Tasks;

namespace MyWebApi
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();

            services.AddAuthentication("BasicAuthentication")
                .AddScheme<AuthenticationSchemeOptions, BasicAuthenticationHandler>("BasicAuthentication", null);

            services.AddAuthorization(options =>
            {
                options.AddPolicy("MyPolicy", policy =>
                {
                    policy.RequireAuthenticatedUser();
                    policy.RequireClaim("MyClaim");
                });
            });
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseAuthentication();

            app.UseMvc();
        }
    }

    public class BasicAuthenticationHandler : AuthenticationHandler<AuthenticationSchemeOptions>
    {
        protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
        {
            if (!Request.Headers.ContainsKey("Authorization"))
                return AuthenticateResult.Fail("Missing Authorization Header");

            string username = "", password = "";
            var authHeader = AuthenticationHeaderValue.Parse(Request.Headers["Authorization"]);
            var credentialBytes = Convert.FromBase64String(authHeader.Parameter);
            var credentials = Encoding.UTF8.GetString(credentialBytes).Split(':');
            username = credentials[0];
            password = credentials[1];

            if (username != "myusername" || password != "mypassword")
                return AuthenticateResult.Fail("Invalid Username or Password");

            var claims = new[] { new Claim(ClaimTypes.Name, username) };
            var identity = new ClaimsIdentity(claims, Scheme.Name);
            var principal = new ClaimsPrincipal(identity);
            var ticket = new AuthenticationTicket(principal, Scheme.Name);

            return AuthenticateResult.Success(ticket);
        }
    }
}

在上面的代码中，我们使用了基本身份验证认证方案，并添加了一个名为“MyPolicy”的授权策略。我们还实现了一个名为“BasicAuthenticationHandler”的自定义身份验证处理程序，用于验证用户名和密码。

  1. 在“Controllers”文件夹中，创建一个名为“MyController.cs”的文件，并添加以下代码：
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Authorize(Policy = "MyPolicy")]
    [Route("api/[controller]")]
    public class MyController : Controller
    {
        [HttpGet]
        public IActionResult MyAction()
        {
            return Ok();
        }
    }
}

在上面的代码中，我们使用了“Authorize”特性，并指定了“MyPolicy”授权策略。

  1. 在命令行中，使用以下命令运行应用程序：
dotnet run
  1. 在命令行中，使用以下命令向“/api/my”端点发送GET请求，并在请求头中添加基本身份验证凭据：
curl -H "Authorization: Basic <base64_encoded_username_and_password>" http://localhost:5000/api/my

在上面的命令中，我们使用了curl命令向“/api/my”端点发送GET请求，并在请求头中添加基本身份验证凭据。

  1. 应该看到200成功的响应。

结论

在本攻略中，我们介绍了如何在ASP.NET Core WebApi中实现认证和授权，并提供了两个示例说明。我们使用了JWT令牌认证和授权以及基本身份验证认证和授权。通过使用认证和授权，我们可以确保WebApi在传输数据时具有更高的安全性。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：手把手教你AspNetCore WebApi认证与授权的方法 - Python技术站

赞 (0)
0 0 打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023年5月17日
下一篇 2023年5月17日

相关文章

  • C# TryGetValue(TKey,TValue)：获取具有指定键的值

    C#中的TryGetValue(TKey,TValue)是一个可以用于Dictionary类的方法。该方法的作用是获取指定键所对应的值，如果不存在则返回默认值。下面是该方法的完整攻略。 方法语法 Dictionary类型的TryGetValue()方法有如下两个重载形式： public bool TryGetValue(TKey key, out TValu…

    C# 2023年4月19日
    00

  • linq中的聚合操作符

    当我们使用LINQ查询数据时，通常需要对数据进行聚合，即对一组数据进行计算，并返回一个聚合结果。在LINQ中，聚合操作符提供了一组强大的工具，帮助我们完成各种不同类型的计算。本文将详细讲解LINQ中的聚合操作符及其使用方法。 聚合操作符概述 在LINQ中，聚合操作符主要包括以下几种： Count Count操作符用于返回一个序列中元素的数量。其语法如下： i…

    C# 2023年6月1日
    00

  • C#简单实现表达式目录树（Expression）

    下面是我对于“C#简单实现表达式目录树（Expression）”的完整攻略。 表达式目录树简介 表达式目录树是一个树形结构，可以用来表示 LINQ 查询和 Lambda 表达式。表达式目录树将表达式树转换为运行时的委托，从而实现了高效的查询。在表达式目录树中，每个节点都表示一个表达式，可以是参数、常量、变量、运算符等。表达式目录树不仅能用于构建查询，还可以用…

    C# 2023年5月31日
    00

  • C#字符串的截取函数用法总结

    下面是关于“C#字符串的截取函数用法总结”完整攻略的内容： 目录 介绍 SubString() 方法 Remove() 方法 示例说明 总结 介绍 在C#中，字符串截取是一种常见的操作。有许多方法可以截取 C# 字符串，其中最常用的是 SubString() 和 Remove() 方法。本文将对这两种方法进行详细的说明，并提供示例说明。 SubString(…

    C# 2023年6月8日
    00

  • Asp.Mvc 2.0用户客户端验证实例讲解(3)

    Asp.Mvc 2.0用户客户端验证实例讲解是一篇教程文章，介绍了如何使用Asp.Mvc 2.0实现用户客户端验证。下面是Asp.Mvc 2.0用户客户端验证实例讲解的完整攻略。 1. 概述 本文将介绍如何使用Asp.Mvc 2.0实现用户客户端验证，在前后端分离开发中，用户客户端验证是非常重要的，可以在一定程度上减少请求次数，提高用户体验，同时还可以避免一…

    C# 2023年5月31日
    00

  • C#字符串与正则表达式的图文详解

    C#字符串与正则表达式的图文详解 1. 什么是正则表达式 正则表达式（Regular Expression）是一种用来描述、匹配文本字符串的工具，它是由元字符和字符组成的表达式。使用正则表达式可以快捷方便的实现字符串的匹配、查找与替换等操作。 2. 正则表达式的基本语法 2.1 元字符 元字符是正则表达式中的特殊字符，其在匹配过程中具有特殊含义，常见的元字符…

    C# 2023年6月7日
    00

  • C#中new的几种用法详解

    C#中new的几种用法详解 一、定义 new 关键字在 C# 中有多种用法，主要的包括以下几种： 创建新的对象实例。 隐藏从基类继承的成员。 使用缺省值初始化值类型的实例。 在泛型类型参数限制约束中指定特定的构造函数。 二、创建新的对象实例 在 C# 中，new 关键字最常用的用法就是创建新的对象实例。我们需要通过 new 关键字和类名来创建对象实例。 下面…

    C# 2023年5月15日
    00

  • asp.net C#实现解压缩文件的方法

    实现解压缩文件的方法可以使用C#中的System.IO.Compression命名空间中的ZipFile类。我们可以使用ZipFile类中提供的方法对zip文件进行解压缩。下面是详细的步骤： 步骤一：导入命名空间 使用前需要导入System.IO.Compression命名空间，使用以下代码： using System.IO.Compression; 步骤二…

    C# 2023年6月1日
    00
合作推广
合作推广
分享本页
返回顶部