IdentityModel 项目教程

1. 项目的目录结构及介绍

IdentityModel 是一个用于构建 OAuth 2.0 和 OpenID Connect 客户端的 .NET 库。以下是项目的目录结构及其介绍：

IdentityModel/
├── src/
│   ├── IdentityModel/
│   │   ├── Constants/
│   │   ├── Discovery/
│   │   ├── Extensions/
│   │   ├── Helpers/
│   │   ├── Models/
│   │   ├── Protocol/
│   │   ├── TokenClient.cs
│   │   ├── TokenClientOptions.cs
│   │   ├── ...
│   ├── IdentityModel.AspNetCore/
│   ├── IdentityModel.OidcClient/
│   ├── ...
├── tests/
│   ├── IdentityModel.Tests/
│   ├── IdentityModel.AspNetCore.Tests/
│   ├── ...
├── docs/
│   ├── index.md
│   ├── ...
├── README.md
├── LICENSE
├── ...

目录结构介绍

• src/: 包含项目的源代码。
  • IdentityModel/: 核心库，包含与 OAuth 2.0 和 OpenID Connect 相关的协议操作、模型、常量和辅助方法。
  • IdentityModel.AspNetCore/: 针对 ASP.NET Core 的扩展库，提供与身份验证和授权相关的辅助功能。
  • IdentityModel.OidcClient/: 用于原生移动/桌面应用程序的 OpenID Connect 客户端库。
• tests/: 包含项目的单元测试代码。
• docs/: 包含项目的文档文件。
• README.md: 项目的主介绍文件。
• LICENSE: 项目的开源许可证文件。

2. 项目的启动文件介绍

IdentityModel 是一个库项目，没有传统的“启动文件”。它主要通过 NuGet 包的形式被其他应用程序引用和使用。以下是一些关键文件的介绍：

关键文件

• TokenClient.cs: 这是 IdentityModel 库中的一个核心类，用于与 OAuth 2.0 的令牌端点进行交互。它提供了获取访问令牌的方法。
• TokenClientOptions.cs: 配置 TokenClient 的选项类，包括客户端 ID、客户端密钥、令牌端点 URL 等。

使用示例

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

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var disco = await client.GetDiscoveryDocumentAsync("https://demo.identityserver.io");

        if (disco.IsError)
        {
            Console.WriteLine(disco.Error);
            return;
        }

        var tokenResponse = await client.RequestClientCredentialsTokenAsync(new ClientCredentialsTokenRequest
        {
            Address = disco.TokenEndpoint,
            ClientId = "client",
            ClientSecret = "secret",
            Scope = "api1"
        });

        if (tokenResponse.IsError)
        {
            Console.WriteLine(tokenResponse.Error);
            return;
        }

        Console.WriteLine(tokenResponse.AccessToken);
    }
}

3. 项目的配置文件介绍

IdentityModel 库本身没有特定的配置文件，因为它主要通过代码进行配置。然而，在使用 IdentityModel 的 ASP.NET Core 项目中，通常会在 appsettings.json 中配置与身份验证相关的设置。

示例配置

{
  "IdentityServer": {
    "Authority": "https://demo.identityserver.io",
    "ClientId": "client",
    "ClientSecret": "secret",
    "Scopes": [
      "api1"
    ]
  }
}

配置文件介绍

• Authority: 身份服务器的地址。
• ClientId: 客户端的唯一标识符。
• ClientSecret: 客户端的密钥。
• Scopes: 请求的权限范围。

使用配置

在 ASP.NET Core 项目中，可以通过依赖注入获取配置并使用：

public class Startup
{
    public IConfiguration Configuration { get; }

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        var identityServerConfig = Configuration.GetSection("IdentityServer").Get<IdentityServerConfig>();

        services.AddAuthentication(options =>
        {
            options.DefaultScheme = "Bearer";
        })
        .AddJwtBearer("Bearer", options =>
        {
            options.Authority = identityServerConfig.Authority;
            options.Audience = identityServerConfig.ClientId;
        });
    }
}

public class IdentityServerConfig
{
    public string Authority { get; set; }
    public string ClientId { get; set; }
    public string ClientSecret { get; set; }
    public string[] Scopes { get; set; }
}

通过以上配置，可以在 ASP.NET Core 项目中使用 IdentityModel 进行身份验证和授权。