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#异步调用示例详解

    下面是关于“C#异步调用示例详解”的完整攻略，包含两个示例。 1. C#异步调用简介 在C#中，可以使用异步调用来执行长时间运行的操作，例如网络请求或数据库查询。异步调用可以提高应用程序的响应性能，因为它允许应用程序在等待操作完成时继续执行其他任务。 2. 使用async和await关键字进行异步调用 可以使用async和await关键字来执行异步调用。以下…

    C# 2023年5月15日
    00

  • C# 中const,readonly,static的使用小结

    下面是对于“C#中const，readonly，static的使用小结”的详细讲解。 前言 在C#开发中，我们常常会使用const，readonly和static这三个关键字，它们都可以用来定义变量，但具有不同的作用。 const const是常量的意思，其特点是在编译时期已经固定下来了，不可改变。 在C#中，const定义的变量必须在声明时初始化，而且只能…

    C# 2023年5月15日
    00

  • 详解C# 中Session的用法

    详解C# 中Session的用法 什么是Session Session 是指会话，在 Web 应用程序中，它表示从客户端发来的一系列HTTP请求和响应交互。Session 可以用来存储和检索任何类型的对象，且这些对象在整个 Session 生命周期内都可以使用。在 ASP.NET 中可以使用 Session 对象来在服务器上存储和检索用户特定的信息。Sess…

    C# 2023年6月7日
    00

  • C#实现创建，删除，查找，配置虚拟目录实例详解

    C#实现创建，删除，查找，配置虚拟目录实例详解 背景 虚拟目录是Web应用程序和IIS服务器之间的一个重要桥梁，对于Web开发来说，掌握虚拟目录的创建、删除、查找、配置是非常重要的。C#作为一款强大的面向对象编程语言，在实现这些功能方面提供了便捷的解决方案。本文将详细讲解如何使用C#实现创建、删除、查找、配置虚拟目录的方法。 创建虚拟目录 在C#中，可以通过…

    C# 2023年6月3日
    00

  • Windows系统中C#读写ini配置文件的程序代码示例分享

    下面我将详细讲解如何在Windows系统中使用C#读写ini配置文件的程序代码示例，并提供两条实例说明： 1. 什么是ini配置文件？ ini配置文件是一种常见的配置文件格式，使用该格式可以方便地存储和读取应用程序的配置参数。每个ini配置文件由多个节（section）组成，每个节由一个名称和多个键值对（key-value pairs）构成。 例如，下面是一…

    C# 2023年6月1日
    00

  • XUnit数据共享与并行测试

    引言 在单元或者集成测试的过程中，需要测试的用例非常多，如果测试是一条一条过，那么需要花费不少的时间。从 V2 开始，默认情况下 XUnit 自动配置并行（参考资料），大大提升了测试速度。本文将对 ASP.NET CORE WEBAPI 程序进行集成测试，并探讨 XUnit 的数据共享与测试并行的方法。 XUnit默认在一个类内的测试代码是串行执行的，而在不…

    C# 2023年5月10日
    00

  • 将PHP程序中返回的JSON格式数据用gzip压缩输出的方法

    将PHP程序中返回的JSON格式数据用gzip压缩输出的方法是一种优化Web应用性能的方式。下面是详细的攻略步骤： 1. 启用gzip压缩 在PHP应用中启用gzip压缩，需要开启PHP的zlib扩展。可以在php.ini文件中搜索zlib来查看是否已开启。如果没开启，可以手动修改php.ini文件，将以下两行去掉注释： extension=php_zlib…

    C# 2023年6月1日
    00

  • C#模拟MSN窗体抖动的实现代码

    C#模拟MSN窗体抖动的实现代码一般可以采用以下三个步骤： 1.获取窗体当前位置，并定义抖动偏移量； 2.在一定时间内不断改变窗体位置，实现抖动效果； 3.在抖动结束后恢复原始窗体位置。 具体实现步骤如下： 第一步：获取窗体当前位置和定义抖动偏移量 //获取窗口当前位置 Point OldPoint = this.Location; //定义抖动偏移量，根据…

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