使用 Azure AD B2C 在你自己的 Web API 中启用身份验证

• Visual Studio Code
• C# for Visual Studio Code（最新版本）
• .NET 5.0 SDK

• Visual Studio Code 或其他代码编辑器
• Node.js 运行时

使用 dotnet new 命令。 dotnet new 命令创建一个名为 TodoList 的新文件夹，其中包含 Web API 项目资产。 打开目录，然后打开 Visual Studio Code。

dotnet new webapi -o TodoList
cd TodoList
code . 

系统提示你“将所需资产添加到项目”时，请选择“是”。

使用适用于 Node.js 的 Express 生成 Web API。 若要创建 Web API，请执行以下操作：

1. 创建名为 TodoList 的新文件夹。
2. 在 TodoList 文件夹下，创建一个名为 app.js 的文件。
3. 在命令 shell 中，运行 npm init -y。 此命令为 Node.js 项目创建默认的 package.json 文件。
4. 在命令 shell 中，运行 npm install express。 此命令安装 Express 框架。

若要添加身份验证库，请运行以下命令安装相应的包：

dotnet add package Microsoft.Identity.Web

若要添加身份验证库，请运行以下命令安装相应的包：

npm install passport
npm install passport-azure-ad
npm install morgan

morgan 包是适用于 Node.js 的 HTTP 请求记录器中间件。

打开 Startup.cs，然后在类的开头添加以下 using 声明：

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.Identity.Web;

找到 ConfigureServices(IServiceCollection services) 函数。 然后在 services.AddControllers(); 代码行的前面添加以下代码片段：

public void ConfigureServices(IServiceCollection services)
{
    // Adds Microsoft Identity platform (Azure AD B2C) support to protect this Api
    services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
            .AddMicrosoftIdentityWebApi(options =>
    {
        Configuration.Bind("AzureAdB2C", options);

        options.TokenValidationParameters.NameClaimType = "name";
    },
    options => { Configuration.Bind("AzureAdB2C", options); });
    // End of the Microsoft Identity platform block    

    services.AddControllers();
}

找到 Configure 函数。 然后，紧接在 app.UseRouting(); 代码行的后面添加以下代码片段：

app.UseAuthentication();

更改后，你的代码应如以下代码片段所示：

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

    app.UseHttpsRedirection();

    app.UseRouting();
    
    // Add the following line 
    app.UseAuthentication();
    // End of the block you add
    
    app.UseAuthorization();

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

将以下 JavaScript 代码添加到 app.js 文件。

// Import the required libraries
const express = require('express');
const morgan = require('morgan');
const passport = require('passport');
const config = require('./config.json');

// Import the passport Azure AD library
const BearerStrategy = require('passport-azure-ad').BearerStrategy;

// Set the Azure AD B2C options
const options = {
    identityMetadata: `https://${config.credentials.tenantName}.b2clogin.cn/${config.credentials.tenantName}.partner.onmschina.cn/${config.policies.policyName}/${config.metadata.version}/${config.metadata.discovery}`,
    clientID: config.credentials.clientID,
    audience: config.credentials.clientID,
    issuer: config.credentials.issuer,
    policyName: config.policies.policyName,
    isB2C: config.settings.isB2C,
    scope: config.resource.scope,
    validateIssuer: config.settings.validateIssuer,
    loggingLevel: config.settings.loggingLevel,
    passReqToCallback: config.settings.passReqToCallback
}

// Instantiate the passport Azure AD library with the Azure AD B2C options
const bearerStrategy = new BearerStrategy(options, (token, done) => {
        // Send user info using the second argument
        done(null, { }, token);
    }
);

// Use the required libraries
const app = express();

app.use(morgan('dev'));

app.use(passport.initialize());

passport.use(bearerStrategy);

//enable CORS (for testing only -remove in production/deployment)
app.use((req, res, next) => {
    res.header('Access-Control-Allow-Origin', '*');
    res.header('Access-Control-Allow-Headers', 'Authorization, Origin, X-Requested-With, Content-Type, Accept');
    next();
});

在 /Controllers 文件夹下，添加 PublicController.cs 文件，然后将其添加到以下代码片段：

using System;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace TodoList.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class PublicController : ControllerBase
    {
        private readonly ILogger<PublicController> _logger;

        public PublicController(ILogger<PublicController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public ActionResult Get()
        {
            return Ok( new {date = DateTime.UtcNow.ToString()});
        }
    }
}

在 app.js 文件中，添加以下 JavaScript 代码：

// API anonymous endpoint
app.get('/public', (req, res) => res.send( {'date': new Date() } ));

在 /Controllers 文件夹下，添加 HelloController.cs 文件，然后将其添加到以下代码：

using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Microsoft.Identity.Web.Resource;

namespace TodoList.Controllers
{
    [Authorize]
    [RequiredScope("tasks.read")]
    [ApiController]
    [Route("[controller]")]
    public class HelloController : ControllerBase
    {

        private readonly ILogger<HelloController> _logger;
        private readonly IHttpContextAccessor _contextAccessor;

        public HelloController(ILogger<HelloController> logger, IHttpContextAccessor contextAccessor)
        {
            _logger = logger;
            _contextAccessor = contextAccessor;
        }

        [HttpGet]
        public ActionResult Get()
        {
            return Ok( new { name = User.Identity.Name});
        }
    }
}

HelloController 控制器由 AuthorizeAttribute 修饰，这将仅向已通过身份验证的用户授予访问权限。

该控制器还使用 [RequiredScope("tasks.read")] 进行修饰。 RequiredScopeAttribute 验证 Web API 是否是使用正确的范围 tasks.read 调用的。

在 app.js 文件中，添加以下 JavaScript 代码：

// API protected endpoint
app.get('/hello',
    passport.authenticate('oauth-bearer', {session: false}),
    (req, res) => {
        console.log('Validated claims: ', req.authInfo);
        
        // Service relies on the name claim.  
        res.status(200).json({'name': req.authInfo['name']});
    }
);

/hello 终结点首先调用 passport.authenticate() 函数。 该身份验证函数仅向已通过身份验证的用户授予访问权限。

该身份验证函数还会验证 Web API 是否是使用正确的范围调用的。 配置文件中指定了允许的范围。

将以下 JSON 代码片段添加到 appsettings.json 文件。

"Kestrel": {
    "EndPoints": {
      "Http": {
        "Url": "http://localhost:6000"
      },
      "Https": {
         "Url": "https://localhost:6001"   
        }
    }
  }

将以下 JavaScript 代码添加到 app.js 文件。 可以为 Node 应用程序设置 HTTP 和 HTTPS 终结点。

// Starts listening on port 6000
const port = process.env.PORT || 6000;

app.listen(port, () => {
    console.log('Listening on port ' + port);
});

在项目根文件夹下，打开 appsettings.json 文件，然后添加以下设置：

{
  "AzureAdB2C": {
    "Instance": "https://contoso.b2clogin.cn",
    "Domain": "contoso.partner.onmschina.cn",
    "ClientId": "<web-api-app-application-id>",
    "SignedOutCallbackPath": "/signout/<your-sign-up-in-policy>",
    "SignUpSignInPolicyId": "<your-sign-up-in-policy>"
  },
  // More settings here
}

在 appsettings.json 文件中，更新以下属性：

在项目根文件夹下，创建一个 config.json 文件，然后将其添加到以下 JSON 代码片段：

{
    "credentials": {
        "tenantName": "<your-tenant-name>.partner.onmschina.cn",
        "clientID": "<your-webapi-application-ID>",
        "issuer": "https://<your-tenant-name>.b2clogin.cn/<your-tenant-ID>/v2.0/"
    },
    "policies": {
        "policyName": "b2c_1_susi"
    },
    "resource": {
        "scope": ["tasks.read"]
    },
    "metadata": {
        "discovery": ".well-known/openid-configuration",
        "version": "v2.0"
    },
    "settings": {
        "isB2C": true,
        "validateIssuer": true,
        "passReqToCallback": false,
        "loggingLevel": "info"
    }
}

在 config.json 文件中，更新以下属性：

在命令 shell 中，通过运行以下命令来启动 Web 应用：

 dotnet run

你应会看到以下输出，这意味着你的应用已启动并正在运行，并已做好接收请求的准备。

Now listening on: http://localhost:6000

若要停止该程序，请在命令 shell 中选择“Ctrl+C”。 可以使用 node app.js 命令重新运行应用。

打开浏览器并转到 http://localhost:6000/public。 在浏览器窗口中，应会看到显示了以下文本以及当前日期和时间。

在命令 shell 中，通过运行以下命令来启动 Web 应用：

node app.js

你应会看到以下输出，这意味着你的应用已启动并正在运行，并已做好接收请求的准备。

Example app listening on port 6000!

若要停止该程序，请在命令 shell 中选择“Ctrl+C”。 可以使用 node app.js 命令重新运行应用。

打开浏览器并转到 http://localhost:6000/public。 在浏览器窗口中，应会看到显示了以下文本以及当前日期和时间。

• 使用 Microsoft 标识库获取 Web API。

• 使用 Passport.js 库获取 Web API。