Ativar a autenticação na sua própria API Web Node.js com o Azure Active Directory B2C

Neste artigo, vai aprender a criar a sua aplicação Web que chama a sua API Web. A API Web tem de ser protegida pelo Azure Active Directory B2C (Azure AD B2C). Para autorizar o acesso a uma API Web, serve pedidos que incluem um token de acesso válido emitido pelo Azure AD B2C.

Pré-requisitos

Passo 1: Criar uma API Web protegida

Siga estes passos para criar a sua API Web Node.js.

Passo 1.1: Criar o projeto

Utilize o Express para Node.js para criar uma API Web. Para criar uma API Web, faça o seguinte:

  1. Crie uma nova pasta com o nome TodoList.
  2. Na pasta, crie um ficheiro com o TodoList nome index.js.
  3. Numa shell de comandos, execute npm init -y. Este comando cria um ficheiro predefinido package.json para o projeto Node.js.
  4. Na shell de comandos, execute npm install express. Este comando instala a arquitetura Express.

Passo 1.2: Instalar dependências

Adicione a biblioteca de autenticação ao projeto da API Web. A biblioteca de autenticação analisa o cabeçalho de autenticação HTTP, valida o token e extrai afirmações. Para obter mais informações, veja a documentação da biblioteca.

Para adicionar a biblioteca de autenticação, instale os pacotes ao executar o seguinte comando:

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

O pacote morgan é um middleware de logger de pedido HTTP para Node.js.

Passo 1.3: Escrever o código do servidor da API Web

index.js No ficheiro, adicione o seguinte código:

const express = require('express');
const morgan = require('morgan');
const passport = require('passport');
const config = require('./config.json');
const todolist = require('./todolist');
const cors = require('cors');

//<ms_docref_import_azuread_lib>
const BearerStrategy = require('passport-azure-ad').BearerStrategy;
//</ms_docref_import_azuread_lib>

global.global_todos = [];

//<ms_docref_azureadb2c_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,
    policyName: config.policies.policyName,
    isB2C: config.settings.isB2C,
    validateIssuer: config.settings.validateIssuer,
    loggingLevel: config.settings.loggingLevel,
    passReqToCallback: config.settings.passReqToCallback
}

//</ms_docref_azureadb2c_options>

//<ms_docref_init_azuread_lib>
const bearerStrategy = new BearerStrategy(options, (token, done) => {
        // Send user info using the second argument
        done(null, { }, token);
    }
);
//</ms_docref_init_azuread_lib>
const app = express();

app.use(express.json()); 

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

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

app.use(passport.initialize());

passport.use(bearerStrategy);

// To do list endpoints
app.use('/api/todolist', todolist);

//<ms_docref_protected_api_endpoint>
// API endpoint, one must present a bearer accessToken to access this 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']});
    }
);
//</ms_docref_protected_api_endpoint>

//<ms_docref_anonymous_api_endpoint>
// API anonymous endpoint, returns a date to the caller.
app.get('/public', (req, res) => res.send( {'date': new Date() } ));
//</ms_docref_anonymous_api_endpoint>

const port = process.env.PORT || 5000;

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

Tome nota dos seguintes fragmentos de código no index.jsficheiro:

  • Importa a biblioteca de Microsoft Entra de passaportes

    const BearerStrategy = require('passport-azure-ad').BearerStrategy;
    
  • Define as opções Azure AD B2C

    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,
        policyName: config.policies.policyName,
        isB2C: config.settings.isB2C,
        validateIssuer: config.settings.validateIssuer,
        loggingLevel: config.settings.loggingLevel,
        passReqToCallback: config.settings.passReqToCallback
    }
    
  • Instanciar o passaporte Microsoft Entra biblioteca com as opções do Azure AD B2C

    const bearerStrategy = new BearerStrategy(options, (token, done) => {
            // Send user info using the second argument
            done(null, { }, token);
        }
    );
    
  • O ponto final protegido da API. Serve pedidos que incluem um token de acesso emitido por Azure AD B2C válido. Este ponto final devolve o valor da name afirmação no token de acesso.

    // API endpoint, one must present a bearer accessToken to access this 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']});
        }
    );
    
  • O ponto final anónimo da API. A aplicação Web pode chamá-la sem apresentar um token de acesso. Utilize-a para depurar a API Web com chamadas anónimas.

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

Passo 1.4: Configurar a API Web

Adicione configurações a um ficheiro de configuração. O ficheiro contém informações sobre a sua Azure AD fornecedor de identidade B2C. A aplicação API Web utiliza estas informações para validar o token de acesso que a aplicação Web passa como um token de portador.

  1. Na pasta raiz do projeto, crie um config.json ficheiro e, em seguida, adicione-lhe o seguinte objeto JSON:

    {
        "credentials": {
            "tenantName": "fabrikamb2c",
            "clientID": "93733604-cc77-4a3c-a604-87084dd55348"
        },
        "policies": {
            "policyName": "B2C_1_susi"
        },
        "resource": {
            "scope": ["tasks.read"]
        },
        "metadata": {
            "authority": "login.microsoftonline.com",
            "discovery": ".well-known/openid-configuration",
            "version": "v2.0"
        },
        "settings": {
            "isB2C": true,
            "validateIssuer": true,
            "passReqToCallback": false,
            "loggingLevel": "info"
        }
    }
    
  2. config.json No ficheiro, atualize as seguintes propriedades:

Section Chave Valor
credenciais tenantName A primeira parte do seu Azure AD nome do inquilino B2C (por exemplo, fabrikamb2c).
credenciais clientID O ID da aplicação da API Web. Para saber como obter o ID de registo da aplicação da API Web, veja Pré-requisitos.
políticas policyName Os fluxos de utilizador ou a política personalizada. Para saber como obter o fluxo de utilizador ou a política, veja Pré-requisitos.
recurso scope Os âmbitos do registo da aplicação da API Web, como [tasks.read]. Para saber como obter o âmbito da API Web, veja Pré-requisitos.

Passo 2: Criar a aplicação Web do Nó Web

Siga estes passos para criar a aplicação Web Node. Esta aplicação Web autentica um utilizador para adquirir um token de acesso que é utilizado para chamar a API Web do Nó que criou no passo 1:

Passo 2.1: Criar o projeto de nó

Crie uma pasta para manter a sua aplicação de nó, como call-protected-api.

  1. No terminal, altere o diretório para a pasta da aplicação de nó, como cd call-protected-api, e execute npm init -y. Este comando cria um ficheiro package.json predefinido para o projeto Node.js.

  2. No terminal, execute npm install express. Este comando instala a arquitetura Express.

  3. Crie mais pastas e ficheiros para alcançar a seguinte estrutura de projeto:

    call-protected-api/
    ├── index.js
    └── package.json
    └── .env
    └── views/
        └── layouts/
            └── main.hbs
        └── signin.hbs
        └── api.hbs
    

    A views pasta contém ficheiros da barra de identificadores para a IU da aplicação Web.

Passo 2.2: Instalar as dependências

No terminal, instale os dotenvpacotes , express-handlebars, express-sessione @azure/msal-node ao executar os seguintes comandos:

npm install dotenv
npm install express-handlebars
npm install express
npm install axios
npm install express-session
npm install @azure/msal-node

Passo 2.3: Criar componentes da IU da aplicação Web

  1. main.hbs No ficheiro, adicione o seguinte código:

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
        <title>Azure AD B2C | Enable authenticate on web API using MSAL for B2C</title>
    
        <!-- adding Bootstrap 4 for UI components  -->
        <!-- CSS only -->
        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
        <link rel="SHORTCUT ICON" href="https://c.s-microsoft.com/favicon.ico?v2" type="image/x-icon">
      </head>
      <body>
        <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
          <a class="navbar-brand" href="/">Microsoft Identity Platform</a>
            {{#if showSignInButton}}
                <div class="ml-auto">
                    <a type="button" id="SignIn" class="btn btn-success" href="/signin" aria-haspopup="true" aria-expanded="false">
                        Sign in to call PROTECTED API
                    </a>
                    <a type="button" id="SignIn" class="btn btn-warning" href="/api" aria-haspopup="true" aria-expanded="false">
                        Or call the ANONYMOUS API 
                     </a>
                </div>
            {{else}}
                    <p class="navbar-brand d-flex ms-auto">Hi {{givenName}}</p>
                    <a class="navbar-brand d-flex ms-auto" href="/signout">Sign out</a>
            {{/if}}
        </nav>
        <br>
        <h5 class="card-header text-center">MSAL Node Confidential Client application with Auth Code Flow</h5>
        <br>
        <div class="row" style="margin:auto" >
          {{{body}}}
        </div>
        <br>
        <br>
      </body>
    </html>
    

    O main.hbs ficheiro está na pasta e deve conter qualquer código HTML que seja necessário em toda a layout aplicação. Implementa a IU criada com o Bootstrap 5 CSS Framework. Qualquer IU que mude de página para página, como signin.hbs, é colocada no marcador de posição apresentado como {{{body}}}.

  2. signin.hbs No ficheiro, adicione o seguinte código:

    <div class="col-md-3" style="margin:auto">
      <div class="card text-center">
        <div class="card-body">
          {{#if showSignInButton}}
    
          {{else}}
               <h5 class="card-title">You have signed in</h5>
              <a type="button" id="Call-api" class="btn btn-success" href="/api" aria-haspopup="true" aria-expanded="false">
                  Call the PROTECTED API
              </a>
          {{/if}}
        </div>
        </div>
      </div>
    </div>
    
  3. api.hbs No ficheiro, adicione o seguinte código:

    <div class="col-md-3" style="margin:auto">
      <div class="card text-center bg-{{bg_color}}">
        <div class="card-body">
    
              <h5 class="card-title">{{data}}</h5>
    
        </div>
      </div>
    </div>
    

    Esta página apresenta a resposta da API. O bg-{{bg_color}} atributo de classe no cartão do Bootstrap permite que a IU apresente uma cor de fundo diferente para os diferentes pontos finais da API.

Passo 2.4: Concluir o código do servidor de aplicações Web

  1. .env No ficheiro, adicione o seguinte código, que inclui a porta http do servidor, os detalhes do registo da aplicação e os detalhes de fluxo/política de início de sessão e inscrição do utilizador:

    SERVER_PORT=3000
    #web apps client ID
    APP_CLIENT_ID=<You app client ID here>
    #session secret
    SESSION_SECRET=sessionSecretHere
    #web app client secret
    APP_CLIENT_SECRET=<Your app client secret here>
    #tenant name
    TENANT_NAME=<your-tenant-name>
    #B2C sign up and sign in user flow/policy name and authority
    SIGN_UP_SIGN_IN_POLICY_AUTHORITY=https://<your-tenant-name>.b2clogin.com/<your-tenant-name>.onmicrosoft.com/<sign-in-sign-up-user-flow-name>
    AUTHORITY_DOMAIN=https://<your-tenant-name>.b2clogin.com
    #client redorect url
    APP_REDIRECT_URI=http://localhost:3000/redirect
    LOGOUT_ENDPOINT=https://<your-tenant-name>.b2clogin.com/<your-tenant-name>.onmicrosoft.com/<sign-in-sign-up-user-flow-name>/oauth2/v2.0/logout?post_logout_redirect_uri=http://localhost:3000
    

    Modifique os valores nos .env ficheiros conforme explicado em Configurar a aplicação Web de exemplo

  2. No seu index.js ficheiro, adicione o seguinte código:

    /*
     * Copyright (c) Microsoft Corporation. All rights reserved.
     * Licensed under the MIT License.
     */
    require('dotenv').config();
    const express = require('express');
    const session = require('express-session');
    const {engine}  = require('express-handlebars');
    const msal = require('@azure/msal-node');
    //Use axios to make http calls 
    const axios = require('axios');
    
    //<ms_docref_configure_msal>
    /**
     * Confidential Client Application Configuration
     */
     const confidentialClientConfig = {
        auth: {
            clientId: process.env.APP_CLIENT_ID, 
            authority: process.env.SIGN_UP_SIGN_IN_POLICY_AUTHORITY, 
            clientSecret: process.env.APP_CLIENT_SECRET,
            knownAuthorities: [process.env.AUTHORITY_DOMAIN], //This must be an array
            redirectUri: process.env.APP_REDIRECT_URI,
            validateAuthority: false
        },
        system: {
            loggerOptions: {
                loggerCallback(loglevel, message, containsPii) {
                    console.log(message);
                },
                piiLoggingEnabled: false,
                logLevel: msal.LogLevel.Verbose,
            }
        }
    };
    
    // Initialize MSAL Node
    const confidentialClientApplication = new msal.ConfidentialClientApplication(confidentialClientConfig);
    //</ms_docref_configure_msal>
    // Current web API coordinates were pre-registered in a B2C tenant.
    
    //<ms_docref_api_config>
    const apiConfig = {
        webApiScopes: [`https://${process.env.TENANT_NAME}.onmicrosoft.com/tasks-api/tasks.read`],
        anonymousUri: 'http://localhost:5000/public',
        protectedUri: 'http://localhost:5000/hello'
    };
    //</ms_docref_api_config>
    
    /**
     * The MSAL.js library allows you to pass your custom state as state parameter in the Request object
     * By default, MSAL.js passes a randomly generated unique state parameter value in the authentication requests.
     * The state parameter can also be used to encode information of the app's state before redirect. 
     * You can pass the user's state in the app, such as the page or view they were on, as input to this parameter.
     * For more information, visit: https://docs.microsoft.com/azure/active-directory/develop/msal-js-pass-custom-state-authentication-request
     */
    const APP_STATES = {
        LOGIN: 'login',
        CALL_API:'call_api'   
    }
    
    
    /** 
     * Request Configuration
     * We manipulate these two request objects below 
     * to acquire a token with the appropriate claims.
     */
     const authCodeRequest = {
        redirectUri: confidentialClientConfig.auth.redirectUri,
    };
    
    const tokenRequest = {
        redirectUri: confidentialClientConfig.auth.redirectUri,
    };
    
    
    /**
     * Using express-session middleware. Be sure to familiarize yourself with available options
     * and set them as desired. Visit: https://www.npmjs.com/package/express-session
     */
     const sessionConfig = {
        secret: process.env.SESSION_SECRET,
        resave: false,
        saveUninitialized: false,
        cookie: {
            secure: false, // set this to true on production
        }
    }
    //Create an express instance
    const app = express();
    
    //Set handlebars as your view engine
    app.engine('.hbs', engine({extname: '.hbs'}));
    app.set('view engine', '.hbs');
    app.set("views", "./views");
    
    app.use(session(sessionConfig));
    
    /**
     * This method is used to generate an auth code request
     * @param {string} authority: the authority to request the auth code from 
     * @param {array} scopes: scopes to request the auth code for 
     * @param {string} state: state of the application, tag a request
     * @param {Object} res: express middleware response object
     */
    
     const getAuthCode = (authority, scopes, state, res) => {
        // prepare the request
        console.log("Fetching Authorization code")
        authCodeRequest.authority = authority;
        authCodeRequest.scopes = scopes;
        authCodeRequest.state = state;
    
        //Each time you fetch Authorization code, update the authority in the tokenRequest configuration
        tokenRequest.authority = authority;
    
        // request an authorization code to exchange for a token
        return confidentialClientApplication.getAuthCodeUrl(authCodeRequest)
            .then((response) => {
                console.log("\nAuthCodeURL: \n" + response);
                //redirect to the auth code URL/send code to 
                res.redirect(response);
            })
            .catch((error) => {
                res.status(500).send(error);
            });
    }
    
    app.get('/', (req, res) => {
        res.render('signin', { showSignInButton: true });
    });
    
    
    
    app.get('/signin',(req, res)=>{ 
            //Initiate a Auth Code Flow >> for sign in
            //Pass the api scopes as well so that you received both the IdToken and accessToken
            getAuthCode(process.env.SIGN_UP_SIGN_IN_POLICY_AUTHORITY,apiConfig.webApiScopes, APP_STATES.LOGIN, res);
    });
    
    
    app.get('/redirect',(req, res)=>{    
        
        if (req.query.state === APP_STATES.LOGIN) {
            // prepare the request for calling the web API
            tokenRequest.authority = process.env.SIGN_UP_SIGN_IN_POLICY_AUTHORITY;
            tokenRequest.scopes = apiConfig.webApiScopes;
            tokenRequest.code = req.query.code;
            confidentialClientApplication.acquireTokenByCode(tokenRequest)
            .then((response) => {
                req.session.accessToken = response.accessToken;
                req.session.givenName = response.idTokenClaims.given_name;
                console.log('\nAccessToken:' + req.session.accessToken);
                res.render('signin', {showSignInButton: false, givenName: response.idTokenClaims.given_name});
            }).catch((error) => {
                console.log(error);
                res.status(500).send(error);
            });
        }else{
            res.status(500).send('We do not recognize this response!');
        }
    });
    
    //<ms_docref_api_express_route>
    app.get('/api', async (req, res) => {
        if(!req.session.accessToken){
            //User is not logged in and so they can only call the anonymous API
            try {
                const response = await axios.get(apiConfig.anonymousUri);
                console.log('API response' + response.data); 
                res.render('api',{data: JSON.stringify(response.data), showSignInButton: true, bg_color:'warning'});
            } catch (error) {
                console.error(error);
                res.status(500).send(error);
            }         
        }else{
            //Users have the accessToken because they signed in and the accessToken is still in the session
            console.log('\nAccessToken:' + req.session.accessToken);
            let accessToken = req.session.accessToken;
            const options = {
                headers: {
                    //accessToken used as bearer token to call a protected API
                    Authorization: `Bearer ${accessToken}`
                }
            };
    
            try {
                const response = await axios.get(apiConfig.protectedUri, options);
                console.log('API response' + response.data); 
                res.render('api',{data: JSON.stringify(response.data), showSignInButton: false, bg_color:'success', givenName: req.session.givenName});
            } catch (error) {
                console.error(error);
                res.status(500).send(error);
            }
        }     
    });
    
    //</ms_docref_api_express_route>
    
    /**
     * Sign out end point
    */
    app.get('/signout',async (req, res)=>{    
        logoutUri = process.env.LOGOUT_ENDPOINT;
        req.session.destroy(() => {
            res.redirect(logoutUri);
        });
    });
    app.listen(process.env.SERVER_PORT, () => console.log(`Msal Node Auth Code Sample app listening on port !` + process.env.SERVER_PORT));
    

    O código no index.js ficheiro consiste em variáveis globais e rotas rápidas.

    Variáveis globais:

    • confidentialClientConfig: o objeto de configuração MSAL, que é utilizado para criar o objeto de aplicação cliente confidencial.

      /**
       * Confidential Client Application Configuration
       */
       const confidentialClientConfig = {
          auth: {
              clientId: process.env.APP_CLIENT_ID, 
              authority: process.env.SIGN_UP_SIGN_IN_POLICY_AUTHORITY, 
              clientSecret: process.env.APP_CLIENT_SECRET,
              knownAuthorities: [process.env.AUTHORITY_DOMAIN], //This must be an array
              redirectUri: process.env.APP_REDIRECT_URI,
              validateAuthority: false
          },
          system: {
              loggerOptions: {
                  loggerCallback(loglevel, message, containsPii) {
                      console.log(message);
                  },
                  piiLoggingEnabled: false,
                  logLevel: msal.LogLevel.Verbose,
              }
          }
      };
      
      // Initialize MSAL Node
      const confidentialClientApplication = new msal.ConfidentialClientApplication(confidentialClientConfig);
      
    • apiConfig: contém webApiScopes a propriedade (o valor tem de ser uma matriz), que são os âmbitos configurados na API Web e concedidos à aplicação Web. Também tem URIs para a API Web a chamar, ou seja anonymousUri , e protectedUri.

      const apiConfig = {
          webApiScopes: [`https://${process.env.TENANT_NAME}.onmicrosoft.com/tasks-api/tasks.read`],
          anonymousUri: 'http://localhost:5000/public',
          protectedUri: 'http://localhost:5000/hello'
      };
      
    • APP_STATES: um valor incluído no pedido que também é devolvido na resposta do token. Utilizado para diferenciar entre respostas recebidas do Azure AD B2C.

    • authCodeRequest: o objeto de configuração utilizado para obter o código de autorização.

    • tokenRequest: o objeto de configuração utilizado para adquirir um token por código de autorização.

    • sessionConfig: o objeto de configuração para sessão rápida.

    • getAuthCode: um método que cria o URL do pedido de autorização, permitindo ao utilizador introduzir credenciais e dar consentimento à aplicação. Utiliza o getAuthCodeUrl método, que é definido na classe ConfidentialClientApplication .

    Rotas rápidas:

    • /:
      • É a entrada na aplicação Web e compõe a signin página.
    • /signin:
      • Inicia sessão no utilizador.
      • Chama getAuthCode() o método e transmite o authority para Iniciar sessão e inscrever o fluxo/política do utilizador, APP_STATES.LOGINe apiConfig.webApiScopes para o mesmo.
      • Faz com que o utilizador final seja desafiado a introduzir os respetivos inícios de sessão ou, se o utilizador não tiver uma conta, pode inscrever-se.
      • A resposta final resultante deste ponto final inclui um código de autorização do B2C publicado novamente no /redirect ponto final.
    • /redirect:
      • É o ponto final definido como URI de Redirecionamento para a aplicação Web no portal do Azure.
      • Utiliza o state parâmetro de consulta no Azure AD resposta do B2C, para diferenciar entre os pedidos efetuados a partir da aplicação Web.
      • Se o estado da aplicação for APP_STATES.LOGIN, o código de autorização adquirido é utilizado para obter um token com o acquireTokenByCode() método . Ao pedir um token com acquireTokenByCode o método, utilize os mesmos âmbitos utilizados ao adquirir o código de autorização. O token adquirido inclui um accessToken, idTokene idTokenClaims. Depois de adquirir o , coloque-o accessTokennuma sessão para utilização posterior para chamar a API Web.
    • /api:
      • Chama a API Web.
      • Se o accessToken não estiver na sessão, chame o ponto final anónimo da API (http://localhost:5000/public), caso contrário, chame o ponto final da API protegida (http://localhost:5000/hello).
    • /signout:
      • Termina a sessão do utilizador.
      • limpa a sessão da aplicação Web e faz uma chamada http para o ponto final de início de sessão do Azure AD B2C.

Passo 3: Executar a aplicação Web e a API

Siga os passos em Executar a aplicação Web e a API para testar a sua aplicação Web e a API Web.

Passos seguintes