IdentityServer4实战中怎么与API单项目整合

在现代的微服务架构中，身份认证和授权是一个非常重要的环节。IdentityServer4 是一个基于 ASP.NET Core 的开源框架，专门用于实现身份认证和授权。本文将详细介绍如何在单项目中整合 IdentityServer4 和 API，以实现身份认证和授权功能。

1. 环境准备

在开始之前，确保你已经安装了以下工具：

• .NET Core SDK
• Visual Studio 或 Visual Studio Code
• Postman 或其他 API 测试工具

2. 创建 ASP.NET Core 项目

首先，我们需要创建一个 ASP.NET Core 项目。打开命令行工具，执行以下命令：

dotnet new webapi -n IdentityServer4WithApi
cd IdentityServer4WithApi

这将创建一个名为 IdentityServer4WithApi 的 ASP.NET Core Web API 项目。

3. 添加 IdentityServer4 依赖

接下来，我们需要将 IdentityServer4 添加到项目中。在命令行中执行以下命令：

dotnet add package IdentityServer4

这将安装 IdentityServer4 的核心库。

4. 配置 IdentityServer4

在 Startup.cs 文件中，我们需要配置 IdentityServer4。首先，添加以下命名空间：

using IdentityServer4;
using IdentityServer4.Test;

然后，在 ConfigureServices 方法中配置 IdentityServer4：

public void ConfigureServices(IServiceCollection services)
{
    services.AddIdentityServer()
        .AddInMemoryClients(new List<Client>
        {
            new Client
            {
                ClientId = "client",
                AllowedGrantTypes = GrantTypes.ClientCredentials,
                ClientSecrets =
                {
                    new Secret("secret".Sha256())
                },
                AllowedScopes = { "api1" }
            }
        })
        .AddInMemoryApiScopes(new List<ApiScope>
        {
            new ApiScope("api1", "My API")
        })
        .AddTestUsers(new List<TestUser>
        {
            new TestUser
            {
                SubjectId = "1",
                Username = "test",
                Password = "password"
            }
        });

    services.AddControllers();
}

在这个配置中，我们定义了一个客户端 client，它可以使用客户端凭证授权类型来访问 api1 资源。我们还定义了一个测试用户 test，密码为 password。

5. 配置 API 资源

在 Configure 方法中，我们需要配置 API 资源。添加以下代码：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseIdentityServer();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

6. 创建受保护的 API

接下来，我们创建一个受保护的 API。在 Controllers 文件夹中创建一个新的控制器 ProtectedController.cs：

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

namespace IdentityServer4WithApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    [Authorize]
    public class ProtectedController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            return Ok(new { message = "This is a protected API endpoint." });
        }
    }
}

在这个控制器中，我们使用了 [Authorize] 属性来保护 Get 方法，只有经过身份认证的用户才能访问。

7. 测试 API

现在，我们可以测试我们的 API 了。首先，启动项目：

dotnet run

然后，使用 Postman 或其他 API 测试工具来测试 API。

7.1 获取访问令牌

首先，我们需要获取访问令牌。发送以下 POST 请求：

POST /connect/token HTTP/1.1
Host: localhost:5001
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=client&client_secret=secret&scope=api1

如果一切正常，你将收到一个包含访问令牌的响应：

{
    "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ij...",
    "expires_in": 3600,
    "token_type": "Bearer"
}

7.2 访问受保护的 API

接下来，使用获取到的访问令牌来访问受保护的 API。发送以下 GET 请求：

GET /api/protected HTTP/1.1
Host: localhost:5001
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ij...

如果令牌有效，你将收到以下响应：

{
    "message": "This is a protected API endpoint."
}

8. 总结

通过以上步骤，我们成功地在单项目中整合了 IdentityServer4 和 API，并实现了身份认证和授权功能。IdentityServer4 提供了强大的功能，可以轻松地集成到现有的 ASP.NET Core 项目中，帮助我们构建安全的微服务架构。

在实际项目中，你可能需要根据具体需求进一步配置 IdentityServer4，例如使用数据库存储用户和客户端信息、支持多种授权类型等。希望本文能为你提供一个良好的起点，帮助你更好地理解和应用 IdentityServer4。