Verificatie inschakelen in uw eigen web-API met behulp van Azure AD B2C

• Visual Studio Code
• C# voor Visual Studio Code (nieuwste versie)
• .NET 5.0 SDK

• Visual Studio Code of een andere code-editor
• Node.js-runtime

Gebruik de opdracht dotnet new. Met dotnet new de opdracht maakt u een nieuwe map met de naam TodoList met de web-API-projectassets. Open de map en vervolgens Visual Studio Code.

dotnet new webapi -o TodoList
cd TodoList
code . 

Wanneer u wordt gevraagd om vereiste assets aan het project toe te voegen, selecteert u Ja.

Gebruik Express voor Node.js om een web-API te bouwen. Ga als volgt te werk om een web-API te maken:

1. Maak een nieuwe map met de naam TodoList.
2. Maak onder de map TodoList een bestand met de naam app.js.
3. Voer in een opdrachtshell de opdracht uit npm init -y. Met deze opdracht maakt u een standaardbestand package.json voor uw Node.js-project.
4. Voer in de opdrachtshell npm install express uit. Met deze opdracht wordt het Express-framework geïnstalleerd.

Als u de verificatiebibliotheek wilt toevoegen, installeert u het pakket door de volgende opdracht uit te voeren:

dotnet add package Microsoft.Identity.Web

Als u de verificatiebibliotheek wilt toevoegen, installeert u de pakketten door de volgende opdracht uit te voeren:

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

Het Morgan-pakket is een HTTP-aanvraaglogger middleware voor Node.js.

Open Startup.cs en voeg vervolgens aan het begin van de klasse de volgende using declaraties toe:

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

Zoek de functie ConfigureServices(IServiceCollection services). Voeg vervolgens vóór de services.AddControllers(); coderegel het volgende codefragment toe:

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();
}

Zoek de functie Configure. Voeg vervolgens direct na de app.UseRouting(); coderegel het volgende codefragment toe:

app.UseAuthentication();

Na de wijziging moet uw code eruitzien als het volgende codefragment:

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();
    });
}

Voeg de volgende JavaScript-code toe aan uw app.js-bestand .

// 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.com/${config.credentials.tenantName}.onmicrosoft.com/${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();
});

Voeg onder de map /Controllers een PublicController.cs-bestand toe en voeg het toe aan het volgende codefragment:

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()});
        }
    }
}

Voeg in het bestandapp.js de volgende JavaScript-code toe:

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

Voeg onder de map /Controllers een HelloController.cs-bestand toe en voeg het toe aan de volgende code:

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});
        }
    }
}

De HelloController controller is ingericht met de AuthorizeAttribute, waardoor alleen de toegang tot geverifieerde gebruikers wordt beperkt.

De controller is ook versierd met de [RequiredScope("tasks.read")]. De RequiredScopeAttribute controleert of de web-API wordt aangeroepen met de juiste scopes, tasks.read.

Voeg in het bestandapp.js de volgende JavaScript-code toe:

// 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']});
    }
);

Het /hello eindpunt roept eerst de passport.authenticate() functie aan. De verificatiefunctie beperkt de toegang tot geverifieerde gebruikers alleen.

De authenticatiefunctie controleert ook of de web-API wordt aangeroepen met de juiste toegangsrechten. De toegestane bereiken bevinden zich in het configuratiebestand.

Voeg het volgende JSON-fragment toe aan het appsettings.json-bestand .

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

Voeg de volgende JavaScript-code toe aan het app.js-bestand . Het is mogelijk om HTTP- en HTTPS-eindpunten in te stellen voor de Node-toepassing.

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

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

Open onder de hoofdmap van het project het appsettings.json-bestand en voeg de volgende instellingen toe:

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

Werk in het bestandappsettings.json de volgende eigenschappen bij:

Maak onder de hoofdmap van het project een config.json-bestand en voeg het toe aan het volgende JSON-fragment:

{
    "credentials": {
        "tenantName": "<your-tenant-name>.onmicrosoft.com",
        "clientID": "<your-webapi-application-ID>",
        "issuer": "https://<your-tenant-name>.b2clogin.com/<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"
    }
}

Werk in het bestandconfig.json de volgende eigenschappen bij:

Start de web-app in de opdrachtshell door de volgende opdracht uit te voeren:

 dotnet run

Als het goed is, ziet u de volgende uitvoer, wat betekent dat uw app actief is en klaar is om aanvragen te behandelen.

Now listening on: http://localhost:6000

Als u het programma wilt stoppen, selecteert u Ctrl+C in de opdrachtshell. U kunt de app opnieuw uitvoeren met behulp van de node app.js opdracht.

Open een browser en ga naar http://localhost:6000/public. In het browservenster ziet u de volgende tekst, samen met de huidige datum en tijd.

Start de web-app in de opdrachtshell door de volgende opdracht uit te voeren:

node app.js

Als het goed is, ziet u de volgende uitvoer, wat betekent dat uw app actief is en klaar is om aanvragen te behandelen.

Example app listening on port 6000!

Als u het programma wilt stoppen, selecteert u Ctrl+C in de opdrachtshell. U kunt de app opnieuw uitvoeren met behulp van de node app.js opdracht.

Open een browser en ga naar http://localhost:6000/public. In het browservenster ziet u de volgende tekst, samen met de huidige datum en tijd.

• Haal de web-API op met behulp van de Microsoft-identiteitsbibliotheek.

• Haal de web-API op met behulp van de Passport.js-bibliotheek.