Adición de autenticación a un bot

Disponible para bots de C#, JavaScript y Python.

Disponible para bots de C#, JavaScript y Python.

Disponible para bots en todos los lenguajes de programación: C#, JavaScript, Java y Python.

1. Abra la página de recursos Azure Bot de su bot en Azure Portal.

2. Haga clic en Configuración.

3. En Configuración de conexión de OAuth, cerca de la parte inferior de la página, seleccione Agregar configuración.

4. Rellene el formulario de la siguiente manera:

   1. Nombre. Escriba un nombre para la conexión. Lo usará en el código del bot.

   2. Proveedor de servicios. Seleccione Microsoft Entra ID para mostrar los campos específicos de Microsoft Entra ID.

   3. Id. de cliente. Escriba el identificador de aplicación (cliente) que registró para el proveedor de identidades de Microsoft Entra ID.

   4. Secreto de cliente. Escriba el secreto que registró para el proveedor de identidades de Microsoft Entra ID.

      Sugerencia

      Si desea usar certificados, puede seleccionar el proveedor AAD v2 con certificados. Deberá conceder al Servicio de bot Token Store (appid: 5b404cf4-a79d-4cfe-b866-24bf8e1a4921) el permiso para obtener el certificado.

   5. Dirección URL de intercambio de tokens. Déjelo en blanco porque solo se usa para el SSO en Microsoft Entra ID.

   6. Id. de inquilino. Escriba el identificador de directorio (inquilino) que registró anteriormente para la aplicación de Microsoft Entra ID o common (común) según los tipos de cuenta admitidos seleccionados al crear la aplicación de Azure DD. Para decidir qué valor asignar, siga estos criterios:

      • Al crear la aplicación de Microsoft Entra ID, si seleccionó solo las cuentas de este directorio organizativo (solo Microsoft: un solo inquilino), especifique el valor de identificador del inquilino que anotó anteriormente para la aplicación de Microsoft Entra ID.
      • Sin embargo, si seleccionó Cuentas en cualquier directorio organizativo (cualquier directorio de Microsoft Entra ID: multiinquilino y cuentas personales de Microsoft, como Xbox o Outlook.com) o Cuentas en cualquier directorio organizativo (directorio de Microsoft Entra ID: multiinquilino), escriba common en lugar de un identificador de inquilino. De lo contrario, la aplicación de Microsoft Entra ID realizará la verificación en el inquilino cuyo identificador se seleccionó y excluirá las cuentas personales de Microsoft.

      Este será el inquilino asociado a los usuarios que se pueden autenticar. Para más información, consulte Inquilinos en Microsoft Entra ID.

   7. En Ámbitos, escriba los nombres de los permisos que eligió en el registro de la aplicación. Con fines de prueba, puede escribir openid profile.

      Nota:

      Para Microsoft Entra ID, el campo Ámbitos toma una lista de valores que distingue mayúsculas de minúsculas, separados por espacios.

5. Seleccione Guardar.

1. Vaya hasta la página de recursos del bot en Azure Portal.

2. Haga clic en Configuración.

3. En Configuración de conexión de OAuth, cerca de la parte inferior de la página, seleccione Agregar configuración.

4. Rellene el formulario de la siguiente manera:

   1. Para Nombre, escriba un nombre para la conexión. Este nombre se usará en el código del bot.

   2. Para Proveedor de servicios, seleccione Microsoft Entra ID. Después de seleccionar esta opción, se mostrarán los campos específicos de Microsoft Entra ID.

   3. Para Id. de cliente, escriba el identificador de aplicación (cliente) que registró para la aplicación v1 de Azure AD.

   4. En Secreto de cliente, escriba el secreto que ha creado para conceder al bot acceso a la aplicación de Microsoft Entra ID.

   5. En Tipo de concesión, escriba authorization_code.

   6. Para Dirección URL de inicio de sesión, escriba https://login.microsoftonline.com.

   7. Para el identificador de inquilino, escriba el identificador de directorio (inquilino) que registró anteriormente para la aplicación de Microsoft Entra ID o common (común) según los tipos de cuenta admitidos seleccionados al crear la aplicación de AAD. Para decidir qué valor asignar, siga estos criterios:

      • Al crear la aplicación de Microsoft Entra ID, si seleccionó solo las cuentas de este directorio organizativo (solo Microsoft: un solo inquilino), especifique el valor de identificador del inquilino que anotó anteriormente para la aplicación de Microsoft Entra ID.
      • Sin embargo, si seleccionó Cuentas en cualquier directorio organizativo (cualquier directorio de Microsoft Entra ID: multiinquilino y cuentas personales de Microsoft, como Xbox o Outlook.com) o Cuentas en cualquier directorio organizativo (directorio de Microsoft Entra ID: multiinquilino), escriba common en lugar de un identificador de inquilino. De lo contrario, la aplicación de Microsoft Entra ID realizará la verificación en el inquilino cuyo identificador se seleccionó y excluirá las cuentas personales de MS.

      Este será el inquilino asociado a los usuarios que se pueden autenticar. Para más información, consulte Inquilinos en Microsoft Entra ID.

   8. Para URL de recurso, ingrese https://graph.microsoft.com/.

   9. Deje Ámbitos en blanco.

5. Seleccione Guardar.

1. Clone desde el repositorio de GitHub el ejemplo con el que desea trabajar: Autenticación de bot o Autenticación de bot para Microsoft Graph.

2. Actualice appsettings.json:

   • Establezca en ConnectionName el nombre del valor de conexión de OAuth que agregó al bot.

   • Establezca en MicrosoftAppId y MicrosoftAppPassword el id. de la aplicación y secreto de la aplicación del bot.

     En función de los caracteres del secreto del bot, es posible que sea necesario aplicar secuencias de escape XML a la contraseña. Por ejemplo, cualquier símbolo de Y comercial (&) tendrá que codificarse como &.

   {
     "MicrosoftAppType": "",
     "MicrosoftAppId": "",
     "MicrosoftAppPassword": "",
     "MicrosoftAppTenantId": "",
     "ConnectionName": ""
   }
   

   Para usar OAuth en el bot con residencia de datos en la nube pública, debe agregar las siguientes configuraciones en appsettings

   "OAuthUrl": "<Regional-OAuth-Uri>",
   "ToChannelFromBotOAuthScope": "https://api.botframework.com",
   "ToChannelFromBotLoginUrlTemplate": "https://api.botframework.com",
   "PublicAzureChannel": "https://api.botframework.com",
   "ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.com/v1/.well-known/openidconfiguration",
   "ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration",
   "ToBotFromChannelTokenIssuer": "https://api.botframework.com",
   "ToChannelFromBotLoginUrl": "https://login.microsoftonline.com/botframework.com",
   

   Donde <Regional-OAuth-Url> es uno de los siguientes URI:

   URI	Descripción
   https://europe.api.botframework.com	Para bots en la nube pública con residencia de datos en Europa.
   https://unitedstates.api.botframework.com	Para bots en la nube pública con residencia de datos en Estados Unidos.
   https://india.api.botframework.com	Para bots en la nube pública con residencia de datos en La India.

3. Actualización de Startup.cs:

   Para usar OAuth en nubes de Azure no públicas, como la nube gubernamental, debe agregar el código siguiente en el archivo Startup.cs.

   string uri = "<uri-to-use>";
   MicrosoftAppCredentials.TrustServiceUrl(uri);
   OAuthClientConfig.OAuthEndpoint = uri;
   
   

   Donde <uri-to-use> es uno de los siguientes URI:

   URI	Descripción
   https://api.botframework.azure.us	Para bots en la nube gubernamental de Estados Unidos sin residencia de datos.
   https://api.botframework.com	Para bots en la nube pública sin residencia de datos. Este es el URI predeterminado y no requiere un cambio en Startup.cs.

1. Clone desde el repositorio de GitHub con el que desea trabajar: Autenticación de bot o Autenticación de bot para Microsoft Graph.

2. Actualice .env:

   • Establezca en connectionName el nombre del valor de conexión de OAuth que agregó al bot.

   • Establezca en los valores MicrosoftAppId y MicrosoftAppPassword el id. de la aplicación y secreto de la aplicación del bot.

     En función de los caracteres del secreto del bot, es posible que sea necesario aplicar secuencias de escape XML a la contraseña. Por ejemplo, cualquier símbolo de Y comercial (&) tendrá que codificarse como &.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. Clone desde el repositorio de GitHub el ejemplo con el que desea trabajar: Autenticación de bot o Autenticación de bot para Microsoft Graph.

2. Actualice application.properties:

   • Establezca en ConnectionName el nombre del valor de conexión de OAuth que agregó al bot.
   • Establezca en MicrosoftAppId y MicrosoftAppPassword el id. de la aplicación y secreto de la aplicación del bot.

   MicrosoftAppId=
   MicrosoftAppPassword=
   server.port=3978
   ConnectionName=
   

1. Clone del repositorio de GitHub el ejemplo con el que desea trabajar: Autenticación de bot o Autenticación de bot para Microsoft Graph.

2. Actualice config.py:

   • Establezca en ConnectionName el nombre del valor de conexión de OAuth que agregó al bot.

   • Establezca en MicrosoftAppId y MicrosoftAppPassword el id. de la aplicación y secreto de la aplicación del bot.

     En función de los caracteres del secreto del bot, es posible que sea necesario aplicar secuencias de escape XML a la contraseña. Por ejemplo, cualquier símbolo de Y comercial (&) tendrá que codificarse como &.

   #!/usr/bin/env python3
   # Copyright (c) Microsoft Corporation. All rights reserved.
   # Licensed under the MIT License.
   
   import os
   
   """ Bot Configuration """
   
   
   class DefaultConfig:
       """ Bot Configuration """
   
       PORT = 3978
       APP_ID = os.environ.get("MicrosoftAppId", "")
       APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
       APP_TYPE = os.environ.get("MicrosoftAppType", "MultiTenant")
       APP_TENANTID = os.environ.get("MicrosoftAppTenantId", "")
       CONNECTION_NAME = os.environ.get("ConnectionName", "")
   

Dialogs\MainDialog.cs

Agregue un símbolo del sistema de OAuth a MainDialog en su constructor. En este caso, el valor del nombre de la conexión se recuperó del archivo appsettings.json.

AddDialog(new OAuthPrompt(
    nameof(OAuthPrompt),
    new OAuthPromptSettings
    {
        ConnectionName = ConnectionName,
        Text = "Please Sign In",
        Title = "Sign In",
        Timeout = 300000, // User has 5 minutes to login (1000 * 60 * 5)
    }));

En un paso del diálogo, utilice BeginDialogAsync para iniciar el símbolo del sistema de OAuth, que pide al usuario que inicie sesión.

• Si el usuario ya ha iniciado sesión, se generará un evento de respuesta de token sin preguntar al usuario.
• En caso contrario, se le pedirá al usuario que inicie sesión. Servicio de Bot de Azure AI envía el evento de respuesta de token después de que el usuario intenta iniciar sesión.

return await stepContext.BeginDialogAsync(nameof(OAuthPrompt), null, cancellationToken);

En el paso siguiente del diálogo, compruebe la presencia de un token en el resultado del paso anterior. Si no es NULL, significa que el usuario iniciado sesión correctamente.

// Get the token from the previous step. Note that we could also have gotten the
// token directly from the prompt itself. There is an example of this in the next method.
var tokenResponse = (TokenResponse)stepContext.Result;

dialogs/mainDialog.js

Agregue un símbolo del sistema de OAuth a MainDialog en su constructor. En este caso, el valor del nombre de la conexión se recuperó del archivo .env.

this.addDialog(new WaterfallDialog(MAIN_WATERFALL_DIALOG, [
    this.promptStep.bind(this),
    this.loginStep.bind(this),
    this.displayTokenPhase1.bind(this),
    this.displayTokenPhase2.bind(this)
]));

En un paso del diálogo, utilice beginDialog para iniciar el símbolo del sistema de OAuth, que pide al usuario que inicie sesión.

• Si el usuario ya ha iniciado sesión, se generará un evento de respuesta de token sin preguntar al usuario.
• En caso contrario, se le pedirá al usuario que inicie sesión. Servicio de Bot de Azure AI envía el evento de respuesta de token después de que el usuario intenta iniciar sesión.

const tokenResponse = stepContext.result;

En el paso siguiente del diálogo, compruebe la presencia de un token en el resultado del paso anterior. Si no es NULL, significa que el usuario iniciado sesión correctamente.

await stepContext.context.sendActivity('Login was not successful please try again.');
return await stepContext.endDialog();

MainDialog.java

Agregue un símbolo del sistema de OAuth a MainDialog en su constructor. En este caso, el valor del nombre de la conexión se recuperó del archivo application.properties.

OAuthPromptSettings settings = new OAuthPromptSettings();
settings.setText("Please Sign In");
settings.setTitle("Sign In");
settings.setConnectionName(configuration.getProperty("ConnectionName"));
settings.setTimeout(300000); // User has 5 minutes to login (1000 * 60 * 5)

addDialog(new OAuthPrompt("OAuthPrompt", settings));

En un paso del diálogo, utilice beginDialog para iniciar el símbolo del sistema de OAuth, que pide al usuario que inicie sesión.

• Si el usuario ya ha iniciado sesión, se generará un evento de respuesta de token sin preguntar al usuario.
• En caso contrario, se le pedirá al usuario que inicie sesión. Servicio de Bot de Azure AI envía el evento de respuesta de token después de que el usuario intenta iniciar sesión.

return stepContext.beginDialog("OAuthPrompt");

En el paso siguiente del diálogo, compruebe la presencia de un token en el resultado del paso anterior. Si no es NULL, significa que el usuario iniciado sesión correctamente.

// Get the token from the previous step. Note that we could also have gotten the
// token directly from the prompt itself. There instanceof an example of this in the next method.
TokenResponse tokenResponse = (TokenResponse) stepContext.getResult();

dialogs/main_dialog.py

Agregue un símbolo del sistema de OAuth a MainDialog en su constructor. En este caso, el valor del nombre de la conexión se recuperó del archivo config.py.

self.add_dialog(
    WaterfallDialog(
        "WFDialog",
        [
            self.prompt_step,
            self.login_step,
            self.display_token_phase1,
            self.display_token_phase2,
        ],
    )
)

En un paso del diálogo, utilice begin_dialog para iniciar el símbolo del sistema de OAuth, que pide al usuario que inicie sesión.

• Si el usuario ya ha iniciado sesión, se generará un evento de respuesta de token sin preguntar al usuario.
• En caso contrario, se le pedirá al usuario que inicie sesión. Servicio de Bot de Azure AI envía el evento de respuesta de token después de que el usuario intenta iniciar sesión.

return await step_context.begin_dialog(OAuthPrompt.__name__)

En el paso siguiente del diálogo, compruebe la presencia de un token en el resultado del paso anterior. Si no es NULL, significa que el usuario iniciado sesión correctamente.

if step_context.result:
    await step_context.context.send_activity("You are now logged in.")
    return await step_context.prompt(
        ConfirmPrompt.__name__,
        PromptOptions(
            prompt=MessageFactory.text("Would you like to view your token?")
        ),
    )

await step_context.context.send_activity(
    "Login was not successful please try again."
)

Bots\AuthBot.cs

AuthBot deriva de ActivityHandler y controla explícitamente las actividades del evento de respuesta del token. En este caso, seguimos con el diálogo activo, lo que permite que el símbolo del sistema de OAuth procese el evento y recupere el token.

protected override async Task OnTokenResponseEventAsync(ITurnContext<IEventActivity> turnContext, CancellationToken cancellationToken)
{
    Logger.LogInformation("Running dialog with Token Response Event Activity.");

    // Run the Dialog with the new Token Response Event Activity.
    await Dialog.RunAsync(turnContext, ConversationState.CreateProperty<DialogState>(nameof(DialogState)), cancellationToken);
}

bots/authBot.js

AuthBot deriva de ActivityHandler y controla explícitamente las actividades del evento de respuesta del token. En este caso, seguimos con el diálogo activo, lo que permite que el símbolo del sistema de OAuth procese el evento y recupere el token.

await this.dialog.run(context, this.dialogState);

await next();

AuthBot.java

AuthBot deriva de Dialog y controla explícitamente las actividades del evento de respuesta del token. En este caso, seguimos con el diálogo activo, lo que permite que el símbolo del sistema de OAuth procese el evento y recupere el token.

@Override
protected CompletableFuture<Void> onTokenResponseEvent(TurnContext turnContext) {
    LoggerFactory.getLogger(AuthBot.class).info("Running dialog with Token Response Event Activity.");

    // Run the Dialog with the new Token Response Event Activity.
    return Dialog.run(dialog, turnContext, conversationState.createProperty("DialogState"));
}

bots/auth_bot.py

AuthBot controla explícitamente las actividades del evento de respuesta del token. En este caso, seguimos con el diálogo activo, lo que permite que el símbolo del sistema de OAuth procese el evento y recupere el token.

async def on_token_response_event(self, turn_context: TurnContext):
    # Run the Dialog with the new Token Response Event Activity.
    await DialogHelper.run_dialog(
        self.dialog,
        turn_context,
        self.conversation_state.create_property("DialogState"),
    )

Dialogs\LogoutDialog.cs

private async Task<DialogTurnResult> InterruptAsync(DialogContext innerDc, CancellationToken cancellationToken = default(CancellationToken))
{
    if (innerDc.Context.Activity.Type == ActivityTypes.Message)
    {
        var text = innerDc.Context.Activity.Text.ToLowerInvariant();

        if (text == "logout")
        {
            // The UserTokenClient encapsulates the authentication processes.
            var userTokenClient = innerDc.Context.TurnState.Get<UserTokenClient>();
            await userTokenClient.SignOutUserAsync(innerDc.Context.Activity.From.Id, ConnectionName, innerDc.Context.Activity.ChannelId, cancellationToken).ConfigureAwait(false);

            await innerDc.Context.SendActivityAsync(MessageFactory.Text("You have been signed out."), cancellationToken);
            return await innerDc.CancelAllDialogsAsync(cancellationToken);
        }
    }

    return null;
}

dialogs/logoutDialog.js

async interrupt(innerDc) {
    if (innerDc.context.activity.type === ActivityTypes.Message) {
        const text = innerDc.context.activity.text.toLowerCase();
        if (text === 'logout') {
            const userTokenClient = innerDc.context.turnState.get(innerDc.context.adapter.UserTokenClientKey);

            const { activity } = innerDc.context;
            await userTokenClient.signOutUser(activity.from.id, this.connectionName, activity.channelId);

            await innerDc.context.sendActivity('You have been signed out.');
            return await innerDc.cancelAllDialogs();
        }
    }

LogoutDialog.java

private CompletableFuture<DialogTurnResult> interrupt(DialogContext innerDc) {
    if (innerDc.getContext().getActivity().getType().equals(ActivityTypes.MESSAGE)) {
        String text = innerDc.getContext().getActivity().getText().toLowerCase();

        if (text.equals("logout")) {
            // The bot adapter encapsulates the authentication processes.
            BotFrameworkAdapter botAdapter = (BotFrameworkAdapter) innerDc.getContext().getAdapter();
            botAdapter.signOutUser(
                innerDc.getContext(),
                getConnectionName(),
                innerDc.getContext().getActivity().getFrom().getId())
                    .thenApply(result -> innerDc.getContext().sendActivity(MessageFactory.text("You have been signed out."))
                    .thenApply(sendResult -> null));
            return innerDc.cancelAllDialogs();
        }
    }

    return CompletableFuture.completedFuture(null);
}

dialogs/logout_dialog.py

        return result
    return await super().on_continue_dialog(inner_dc)

async def _interrupt(self, inner_dc: DialogContext):
    if inner_dc.context.activity.type == ActivityTypes.message:
        text = inner_dc.context.activity.text.lower()
        if text == "logout":
            user_token_client: UserTokenClient = inner_dc.context.turn_state.get(