Protección de una API de Azure API Management con Azure AD B2C

  • Artículo

Obtenga información sobre cómo restringir el acceso a la API de Azure API Management a los clientes que se han autenticado con Azure Active Directory B2C (Azure AD B2C). Siga las instrucciones de este artículo para crear y probar una directiva de entrada en Azure API Management que restrinja el acceso solo a aquellas solicitudes que incluyan un token de acceso válido emitido por Azure AD B2C.

Requisitos previos

Antes de empezar, asegúrese de que tiene los siguientes recursos implementados:

Obtención del identificador de aplicación de Azure AD B2C

Cuando se protege una API en Azure API Management con Azure AD B2C, se necesitan varios valores para la directiva de entrada que se crea en Azure API Management. En primer lugar, anote el identificador de una aplicación que haya creado anteriormente en el inquilino de Azure AD B2C. Si usa la aplicación que creó para satisfacer los requisitos previos, utilice el id. de aplicación de webapp1.

Para registrar una aplicación en el inquilino de Azure AD B2C, puede usar la nueva experiencia unificada Registros de aplicaciones, o bien nuestra experiencia heredada Aplicaciones. Más información sobre la nueva experiencia de registros.

  1. Inicie sesión en Azure Portal.
  2. Si tiene acceso a varios inquilinos, seleccione el icono Configuración en el menú superior para cambiar a su inquilino de Azure AD B2C desde el menú Directorios y suscripciones.
  3. En el panel de la izquierda, seleccione Azure AD B2C. O bien, puede seleccionar Todos los servicios y, luego, buscar y seleccionar Azure AD B2C.
  4. Seleccione Registros de aplicaciones y, a continuación, la pestaña Aplicaciones propias.
  5. Anote el valor de la columna Id. de aplicación (cliente) de webapp1 u otra aplicación que haya creado previamente.

Obtención del punto de conexión del emisor de un token

A continuación, obtenga la conocida dirección URL de configuración de uno de los flujos de usuario de Azure AD B2C. También necesita el identificador URI del punto de conexión del emisor del token que desea admitir en Azure API Management.

  1. En Azure Portal, vaya al inquilino de Azure AD B2C.

  2. En Directivas, seleccioneFlujos de usuario.

  3. Seleccione una directiva existente (por ejemplo, B2C_1_signupsignin1) y, luego, seleccione Ejecutar flujo de usuario.

  4. Anote la dirección URL del hipervínculo que aparece en el encabezado Ejecutar flujo de usuario situado cerca de la parte superior de la página. Esta dirección URL es el conocido punto de conexión de detección de OpenID Connect del flujo de usuario, que usará en la sección siguiente cuando configure la directiva de entrada en Azure API Management.

    Screenshot of the well-known URI hyperlink on the

  5. Seleccione el hipervínculo para ir a la conocida página de configuración de OpenID Connect.

  6. En la página que se abre en el explorador, registre el valor issuer. Por ejemplo:

    https://<tenant-name>.b2clogin.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/v2.0/

    Este valor se usará en la sección siguiente al configurar la API en Azure API Management.

Ahora debería tener dos direcciones URL anotadas para su uso en la sección siguiente: la dirección URL del punto de conexión de configuración de OpenID Connect y el identificador URI del emisor. Por ejemplo:

https://<tenant-name>.b2clogin.com/<tenant-name>.onmicrosoft.com/B2C_1_signupsignin1/v2.0/.well-known/openid-configuration
https://<tenant-name>.b2clogin.com/99999999-0000-0000-0000-999999999999/v2.0/

Configuración de la directiva de entrada en Azure API Management

Ahora está listo para agregar la directiva de entrada en Azure API Management que valida las llamadas a la API. Puede asegurarse de que solo se aceptan llamadas a la API con un token válido mediante la adición de una directiva de validación de tokens web JSON (JWT) que compruebe la audiencia y el emisor de un token de acceso.

  1. En Azure Portal, vaya a la instancia de Azure API Management.

  2. Seleccione API.

  3. Seleccione la API que desea proteger con Azure AD B2C.

  4. Seleccione la pestaña Diseño.

  5. En Procesamiento de entrada, seleccione </> para abrir el editor de código de directivas.

  6. Coloque la siguiente etiqueta <validate-jwt> dentro de la directiva <inbound> y, a continuación, haga lo siguiente:

    a. Actualice el valor de url del elemento <openid-config> con la conocida dirección URL de configuración de la directiva.
    b. Actualice el elemento <audience> con el id. de aplicación de la aplicación que creó anteriormente en el inquilino de B2C (por ejemplo, webapp1).
    c. Actualice el elemento <issuer> con el punto de conexión del emisor del token que anotó anteriormente.

    <policies>
    <inbound>
        <validate-jwt header-name="Authorization" failed-validation-httpcode="401" failed-validation-error-message="Unauthorized. Access token is missing or invalid.">
            <openid-config url="https://<tenant-name>.b2clogin.com/<tenant-name>.onmicrosoft.com/B2C_1_signupsignin1/v2.0/.well-known/openid-configuration" />
            <audiences>
                <audience>44444444-0000-0000-0000-444444444444</audience>
            </audiences>
            <issuers>
                <issuer>https://<tenant-name>.b2clogin.com/99999999-0000-0000-0000-999999999999/v2.0/</issuer>
            </issuers>
        </validate-jwt>
        <base />
    </inbound>
    <backend> <base /> </backend>
    <outbound> <base /> </outbound>
    <on-error> <base /> </on-error>
</policies>

Validación del acceso protegido a la API

Para asegurarse de que solo los autores de llamada autenticados pueden acceder a la API, puede validar la configuración de Azure API Management mediante una llamada a la API con Postman.

Para llamar a la API, necesita un token de acceso emitido por Azure AD B2C y una clave de suscripción de Azure API Management.

Obtención de un token de acceso

En primer lugar, necesita un token emitido por Azure AD B2C para usarlo en el encabezado Authorization de Postman. Puede obtener uno mediante la característica Ejecutar ahora del flujo de usuario de registro o de inicio de sesión que creó como uno de los requisitos previos.

  1. En Azure Portal, vaya al inquilino de Azure AD B2C.

  2. En Directivas, seleccioneFlujos de usuario.

  3. Seleccione un flujo de usuario de registro o de inicio de sesión existente (por ejemplo, B2C_1_signupsignin1).

  4. En Aplicación, seleccione webapp1.

  5. En Dirección URL de respuesta, seleccione https://jwt.ms.

  6. Seleccione Ejecutar flujo de usuario.

    Screenshot of the

  7. Complete el proceso de inicio de sesión. Debería redirigirse a https://jwt.ms.

  8. Anote el valor del token codificado que se muestra en el explorador. Use este valor de token para el encabezado Authorization de Postman.

    Screenshot of the encoded token value displayed on jwt.ms.

Obtención de una clave de suscripción de API

Una aplicación cliente (en este caso, Postman) que llama a una API publicada debe incluir una clave de suscripción de API Management válida en sus solicitudes HTTP a la API. Para obtener una clave de suscripción para su inclusión en la solicitud HTTP de Postman:

  1. En Azure Portal, vaya a la instancia de servicio de Azure API Management.
  2. Seleccione Suscripciones.
  3. Seleccione los puntos suspensivos ( ... ) junto a Producto: Ilimitado y, a continuación, seleccione Mostrar u ocultar claves.
  4. Anote la clave principal del producto. Esta clave se usa para el encabezado Ocp-Apim-Subscription-Key de la solicitud HTTP en Postman.

Screenshot of the

Prueba de una llamada a la API protegida

Con el token de acceso y la clave de suscripción de Azure API Management anotadas, ya está listo para probar si ha configurado correctamente el acceso seguro a la API.

  1. Cree una nueva solicitud GET en Postman. Para la dirección URL de la solicitud, especifique el punto de conexión de la lista de oradores de la API que publicó como uno de los requisitos previos. Por ejemplo:

    https://contosoapim.azure-api.net/conference/speakers

  2. A continuación, agregue los encabezados siguientes:

    Clave Valor
    Authorization Valor del token codificado que anotó anteriormente, con el prefijo Bearer (incluya el espacio después de "Bearer").
    Ocp-Apim-Subscription-Key La clave de suscripción de Azure API Management que registró anteriormente.

    La dirección URL de la solicitud GET y los Encabezados deben ser similares a los de la imagen siguiente:

    Screenshot of the Postman UI showing the GET request URL and headers.

  3. En Postman, seleccione el botón Enviar para ejecutar la solicitud. Si lo ha configurado todo correctamente, debería aparecer una respuesta JSON con una colección de oradores de conferencia (aquí se muestra truncada):

    {
  "collection": {
    "version": "1.0",
    "href": "https://conferenceapi.azurewebsites.net:443/speakers",
    "links": [],
    "items": [
      {
        "href": "https://conferenceapi.azurewebsites.net/speaker/1",
        "data": [
          {
            "name": "Name",
            "value": "Scott Guthrie"
          }
        ],
        "links": [
          {
            "rel": "http://tavis.net/rels/sessions",
            "href": "https://conferenceapi.azurewebsites.net/speaker/1/sessions"
          }
        ]
      },
[...]

Prueba de una llamada a una API no protegida

Ahora que ha realizado una solicitud correcta, pruebe el caso de error para asegurarse de que las llamadas a la API con un token no válido se rechazan según lo previsto. Una manera de realizar la prueba es agregar o cambiar algunos caracteres en el valor del token y, a continuación, ejecutar la misma solicitud GET que antes.

  1. Agregue varios caracteres al valor del token para simular un token no válido. Por ejemplo, podría agregar "INVALID" al valor del token, como se muestra aquí:

    Screenshot of the Headers section of Postman UI showing the string INVALID added to token.

  2. Seleccione el botón Enviar para ejecutar la solicitud. Con un token no válido, el resultado esperado es un código de estado no autorizado 401:

    {
    "statusCode": 401,
    "message": "Unauthorized. Access token is missing or invalid."
}

Si ve el código de estado 401, habrá comprobado que solo los autores de llamada con un token de acceso válido emitido por Azure AD B2C pueden realizar solicitudes correctas a la API de Azure API Management.

Compatibilidad con varias aplicaciones y emisores

Normalmente, interactúan varias aplicaciones con una sola API REST. Para permitir que la API acepte los tokens destinados a varias aplicaciones, agregue sus id. de aplicación al elemento <audiences> de la directiva de entrada de Azure API Management.

<!-- Accept tokens intended for these recipient applications -->
<audiences>
    <audience>44444444-0000-0000-0000-444444444444</audience>
    <audience>66666666-0000-0000-0000-666666666666</audience>
</audiences>

Del mismo modo, para admitir varios emisores de tokens, agregue sus URI del punto de conexión al elemento <issuers> de la directiva de entrada de Azure API Management.

<!-- Accept tokens from multiple issuers -->
<issuers>
    <issuer>https://<tenant-name>.b2clogin.com/99999999-0000-0000-0000-999999999999/v2.0/</issuer>
    <issuer>https://login.microsoftonline.com/99999999-0000-0000-0000-999999999999/v2.0/</issuer>
</issuers>

Migración a b2clogin.com

Si tiene una API de Azure API Management que valida los tokens emitidos por el punto de conexión heredado login.microsoftonline.com, debe migrar la API y las aplicaciones que lo llaman para que usen tokens emitidos por b2clogin.com.

Puede seguir este proceso general para realizar una migración por fases:

  1. Agregue compatibilidad en la directiva de entrada de Azure API Management para los tokens emitidos por b2clogin.com y login.microsoftonline.com.
  2. Actualice las aplicaciones de una en una para obtener los tokens del punto de conexión b2clogin.com.
  3. Cuando todas las aplicaciones obtengan correctamente tokens de b2clogin.com, elimine de la API la compatibilidad con los tokens emitidos por login.microsoftonline.com.

En el siguiente ejemplo de directiva de entrada de Azure API Management se muestra cómo aceptar tokens emitidos por b2clogin.com y login.microsoftonline.com. Además, la directiva admite solicitudes de API de dos aplicaciones.

<policies>
    <inbound>
        <validate-jwt header-name="Authorization" failed-validation-httpcode="401" failed-validation-error-message="Unauthorized. Access token is missing or invalid.">
            <openid-config url="https://<tenant-name>.b2clogin.com/<tenant-name>.onmicrosoft.com/B2C_1_signupsignin1/v2.0/.well-known/openid-configuration" />
            <audiences>
                <audience>44444444-0000-0000-0000-444444444444</audience>
                <audience>66666666-0000-0000-0000-666666666666</audience>
            </audiences>
            <issuers>
                <issuer>https://login.microsoftonline.com/99999999-0000-0000-0000-999999999999/v2.0/</issuer>
                <issuer>https://<tenant-name>.b2clogin.com/99999999-0000-0000-0000-999999999999/v2.0/</issuer>
            </issuers>
        </validate-jwt>
        <base />
    </inbound>
    <backend> <base /> </backend>
    <outbound> <base /> </outbound>
    <on-error> <base /> </on-error>
</policies>

Pasos siguientes

Para más información sobre las directivas de Azure API Management, consulte el índice de referencia de la directiva de Azure API Management.

Para obtener información sobre la migración de las API web basadas en OWIN y sus aplicaciones a b2clogin.com, consulte Migración de una API web basada en OWIN a b2clogin.com.