Adicionar autenticação a um bot

Disponível para bots C#, JavaScript e Python.

Disponível para bots C#, JavaScript e Python.

Disponível para bots em todas as linguagens de programação: C#, JavaScript, Java e Python.

1. Abra a página de recursos do Bot do Azure do seu bot no portal do Azure.

2. Selecione Definições.

3. Em Configurações de conexão OAuth, na parte inferior da página, selecione Adicionar configuração.

4. Preencha o formulário da seguinte forma:

   1. Nome. Introduza um nome para a sua ligação. Você vai usá-lo em seu código de bot.

   2. Prestador de Serviços. Selecione Microsoft Entra ID para exibir campos específicos do Microsoft Entra ID.

   3. ID do cliente. Insira a ID do aplicativo (cliente) que você registrou para seu provedor de identidade do Microsoft Entra ID.

   4. Segredo do cliente. Introduza o segredo que registou para o seu fornecedor de identidade Microsoft Entra ID.

      Gorjeta

      Se quiser usar certificados, selecione o AAD v2 com provedor de certificados . Você precisará dar ao Bot Service Token Store (appid: 00001111-aaaa-2222-bbbb-3333cccc4444) a permissão para obter o certificado.

   5. URL do Token Exchange. Deixe-o em branco porque ele é usado para SSO somente no Microsoft Entra ID.

   6. ID do inquilino. Insira a ID de diretório (locatário) que você registrou anteriormente para seu aplicativo Microsoft Entra ID ou comum, dependendo dos tipos de conta com suporte selecionados quando você criou o aplicativo DD do Azure. Para decidir qual valor atribuir, siga estes critérios:

      • Ao criar o aplicativo Microsoft Entra ID, se você selecionou Contas somente neste diretório organizacional (somente Microsoft - Locatário único), insira a ID do locatário que você registrou anteriormente para o aplicativo Microsoft Entra ID.
      • No entanto, se você selecionou Contas em qualquer diretório organizacional (Qualquer diretório de ID do Microsoft Entra - Multilocatário e contas pessoais da Microsoft, por exemplo, Xbox, Outlook.com) ou Contas em qualquer diretório organizacional (Diretório de ID do Microsoft Entra - Multilocatário), insira common em vez de um ID de locatário. Caso contrário, o aplicativo Microsoft Entra ID verificará através do locatário cuja ID foi selecionada e excluirá contas pessoais da Microsoft.

      Este será o locatário associado aos usuários que podem ser autenticados. Para obter mais informações, consulte Locação no Microsoft Entra ID.

   7. Em Escopos, insira os nomes da permissão escolhida no registro do aplicativo. Para fins de teste, basta inserir: openid profile.

      Nota

      Para o Microsoft Entra ID, o campo Escopos usa uma lista de valores que diferencia maiúsculas de minúsculas e separadas por espaço.

5. Selecione Guardar.

1. Navegue até a página de recursos do bot no portal do Azure.

2. Selecione Definições.

3. Em Configurações de conexão OAuth, na parte inferior da página, selecione Adicionar configuração.

4. Preencha o formulário da seguinte forma:

   1. Em Nome, insira um nome para sua conexão. Você usará esse nome no código do bot.

   2. Para Service Provider, selecione Microsoft Entra ID. Depois de selecionar isso, os campos específicos do ID do Microsoft Entra serão exibidos.

   3. Para ID do cliente, insira a ID do aplicativo (cliente) que você registrou para seu aplicativo do Azure AD v1.

   4. Em Segredo do cliente, insira o segredo que você criou para conceder ao bot acesso ao aplicativo Microsoft Entra ID.

   5. Em Tipo de concessão, digite authorization_code.

   6. Em URL de login, digite https://login.microsoftonline.com.

   7. Para ID do locatário, insira a ID do diretório (locatário) que você registrou anteriormente para seu aplicativo Microsoft Entra ID ou comum, dependendo dos tipos de conta com suporte selecionados quando você criou o aplicativo ADD. Para decidir qual valor atribuir, siga estes critérios:

      • Ao criar o aplicativo Microsoft Entra ID, se você selecionou Contas somente neste diretório organizacional (somente Microsoft - Locatário único), insira a ID do locatário que você registrou anteriormente para o aplicativo Microsoft Entra ID.
      • No entanto, se você selecionou Contas em qualquer diretório organizacional (Qualquer diretório de ID do Microsoft Entra - Multilocatário e contas pessoais da Microsoft, por exemplo, Xbox, Outlook.com) ou Contas em qualquer diretório organizacional (Diretório de ID do Microsoft Entra - Multilocatário), insira common em vez de um ID de locatário. Caso contrário, o aplicativo Microsoft Entra ID verificará através do locatário cuja ID foi selecionada e excluirá contas pessoais do MS.

      Este será o locatário associado aos usuários que podem ser autenticados. Para obter mais informações, consulte Locação no Microsoft Entra ID.

   8. Para o URL do recurso, introduza https://graph.microsoft.com/.

   9. Deixe Escopos em branco.

5. Selecione Guardar.

1. Clone do repositório GitHub o exemplo com o qual você deseja trabalhar: autenticação de Bot ou autenticação de Bot para Microsoft Graph.

2. Atualização appsettings.json:

   • Defina ConnectionName como o nome da configuração de conexão OAuth que você adicionou ao seu bot.

   • Defina MicrosoftAppId e MicrosoftAppPassword para o ID do aplicativo e o segredo do aplicativo do seu bot.

     Dependendo dos caracteres no segredo do bot, talvez seja necessário escapar da senha. Por exemplo, qualquer E comercial (&) precisará ser codificado como &.

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

   Para usar o OAuth no bot com residência de dados na nuvem pública, você deve adicionar as seguintes configurações em suas configurações de aplicativo

   "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",
   

   Onde <Regional-OAuth-Url> é um dos seguintes URIs:

   URI	Description
   https://europe.api.botframework.com	Para bots de nuvem pública com residência de dados na Europa.
   https://unitedstates.api.botframework.com	Para bots de nuvem pública com residência de dados nos Estados Unidos.
   https://india.api.botframework.com	Para bots de nuvem pública com residência de dados na Índia.

3. Atualização Startup.cs:

   Para usar o OAuth em nuvens do Azure não públicas, como a nuvem governamental, você deve adicionar o código a seguir no arquivo Startup.cs .

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

   Onde <uri-to-use> é um dos seguintes URIs:

   URI	Description
   https://api.botframework.azure.us	Para bots de nuvem do governo dos Estados Unidos sem residência de dados.
   https://api.botframework.com	Para bots de nuvem pública sem residência de dados. Este é o URI padrão e não requer uma alteração no Startup.cs.

1. Clone do repositório GitHub com o qual você deseja trabalhar: autenticação de Bot ou autenticação de Bot para Microsoft Graph.

2. Atualizar .env:

   • Defina connectionName como o nome da configuração de conexão OAuth que você adicionou ao seu bot.

   • Defina MicrosoftAppId e MicrosoftAppPassword valorize o ID do aplicativo e o segredo do aplicativo do seu bot.

     Dependendo dos caracteres no segredo do bot, talvez seja necessário escapar da senha. Por exemplo, qualquer E comercial (&) precisará ser codificado como &.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. Clone do repositório GitHub o exemplo com o qual você deseja trabalhar: autenticação de Bot ou autenticação de Bot para Microsoft Graph.

2. Atualizar application.properties:

   • Defina ConnectionName como o nome da configuração de conexão OAuth que você adicionou ao seu bot.
   • Defina MicrosoftAppId e MicrosoftAppPassword para o ID do aplicativo e o segredo do aplicativo do seu bot.

   MicrosoftAppId=
   MicrosoftAppPassword=
   server.port=3978
   ConnectionName=
   

1. Clone o repositório GitHub no exemplo com o qual você deseja trabalhar: autenticação de Bot ou autenticação de Bot para Microsoft Graph.

2. Atualização config.py:

   • Defina ConnectionName como o nome da configuração de conexão OAuth que você adicionou ao seu bot.

   • Defina MicrosoftAppId e MicrosoftAppPassword para o ID do aplicativo e o segredo do aplicativo do seu bot.

     Dependendo dos caracteres no segredo do bot, talvez seja necessário escapar da senha. Por exemplo, qualquer E comercial (&) precisará ser codificado 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", "")
   

Caixas de diálogo\MainDialog.cs

Adicione um prompt OAuth a MainDialog em seu construtor. Aqui, o valor para o nome da conexão foi recuperado do arquivo 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)
    }));

Em uma etapa de diálogo, use BeginDialogAsync para iniciar o prompt OAuth, que solicita que o usuário entre.

• Se o usuário já estiver conectado, isso gerará um evento de resposta de token, sem avisar o usuário.
• Caso contrário, isso solicitará que o usuário faça login. O Serviço de Bot do Azure AI envia o evento de resposta de token depois que o usuário tenta entrar.

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

Na etapa de diálogo a seguir, verifique a presença de um token no resultado da etapa anterior. Se não for nulo, o usuário entrou com êxito.

// 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;

diálogos/mainDialog.js

Adicione um prompt OAuth a MainDialog em seu construtor. Aqui, o valor para o nome da conexão foi recuperado do arquivo .env .

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

Em uma etapa de diálogo, use beginDialog para iniciar o prompt OAuth, que solicita que o usuário entre.

• Se o usuário já estiver conectado, isso gerará um evento de resposta de token, sem avisar o usuário.
• Caso contrário, isso solicitará que o usuário faça login. O Serviço de Bot do Azure AI envia o evento de resposta de token depois que o usuário tenta entrar.

const tokenResponse = stepContext.result;

Na etapa de diálogo a seguir, verifique a presença de um token no resultado da etapa anterior. Se não for nulo, o usuário entrou com êxito.

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

MainDialog.java

Adicione um prompt OAuth a MainDialog em seu construtor. Aqui, o valor para o nome da conexão foi recuperado do arquivo 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));

Em uma etapa de diálogo, use beginDialog para iniciar o prompt OAuth, que solicita que o usuário entre.

• Se o usuário já estiver conectado, isso gerará um evento de resposta de token, sem avisar o usuário.
• Caso contrário, isso solicitará que o usuário faça login. O Serviço de Bot do Azure AI envia o evento de resposta de token depois que o usuário tenta entrar.

return stepContext.beginDialog("OAuthPrompt");

Na etapa de diálogo a seguir, verifique a presença de um token no resultado da etapa anterior. Se não for nulo, o usuário entrou com êxito.

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

diálogos/main_dialog.py

Adicione um prompt OAuth a MainDialog em seu construtor. Aqui, o valor para o nome da conexão foi recuperado do arquivo config.py .

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

Em uma etapa de diálogo, use begin_dialog para iniciar o prompt OAuth, que solicita que o usuário entre.

• Se o usuário já estiver conectado, isso gerará um evento de resposta de token, sem avisar o usuário.
• Caso contrário, isso solicitará que o usuário faça login. O Serviço de Bot do Azure AI envia o evento de resposta de token depois que o usuário tenta entrar.

return await step_context.begin_dialog(OAuthPrompt.__name__)

Na etapa de diálogo a seguir, verifique a presença de um token no resultado da etapa anterior. Se não for nulo, o usuário entrou com êxito.

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

O AuthBot deriva e ActivityHandler lida explicitamente com atividades de eventos de resposta de token. Aqui, continuamos a caixa de diálogo ativa, que permite que o prompt OAuth processe o evento e recupere o 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

O AuthBot deriva e ActivityHandler lida explicitamente com atividades de eventos de resposta de token. Aqui, continuamos a caixa de diálogo ativa, que permite que o prompt OAuth processe o evento e recupere o token.

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

await next();

AuthBot.java

O AuthBot deriva e Dialog lida explicitamente com atividades de eventos de resposta de token. Aqui, continuamos a caixa de diálogo ativa, que permite que o prompt OAuth processe o evento e recupere o 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

O AuthBot lida explicitamente com atividades de eventos de resposta de token. Aqui, continuamos a caixa de diálogo ativa, que permite que o prompt OAuth processe o evento e recupere o 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"),
    )

Caixas de diálogo\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;
}

diálogos/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);
}

diálogos/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(