Добавление проверки подлинности для бота

Доступно для ботов C#, JavaScript и Python.

Доступно для ботов C#, JavaScript и Python.

Доступно для ботов на всех языках программирования: C#, JavaScript, Java и Python.

1. Откройте в портале Azure страницу ресурса Azure Bot для вашего бота.

2. Выберите Параметры.

3. В разделе "Параметры подключения OAuth" в нижней части страницы выберите "Добавить параметр".

4. Заполните форму следующим образом.

   1. Имя. Введите имя для подключения. Вы будете использовать это в коде вашего бота.

   2. Поставщик услуг. Выберите идентификатор Microsoft Entra, чтобы отобразить поля, относящиеся к идентификатору Microsoft Entra.

   3. Client id. Введите идентификатор приложения (клиента), сохраненный для вашего поставщика удостоверений Microsoft Entra ID.

   4. Секрет клиента. Введите секрет, записанный для поставщика удостоверений личности Microsoft Entra ID.

      Совет

      Если вы хотите использовать сертификаты, вы можете выбрать поставщика AAD v2 with Certificates. Вам потребуется предоставить Службе Bot хранилище токенов (appid: 00001111-aaaa-2222-bbbb-3333cccc4444) разрешение на получение сертификата.

   5. URL обмена токена. Оставьте это поле пустым, поскольку оно используется только для единого входа в системе Microsoft Entra ID.

   6. Идентификатор клиента. Введите идентификатор каталога (клиента), записанный ранее для вашего приложения Microsoft Entra ID, или общий в зависимости от выбранных типов поддерживаемых учетных записей при создании приложения Azure DD. Чтобы решить, какое значение следует назначить, выполните следующие критерии:

      • При создании приложения Microsoft Entra ID, если вы выбрали учетные записи только в этом каталоге организации (только Майкрософт — один клиент), введите идентификатор арендатора, который вы записали ранее для приложения Microsoft Entra ID.
      • Однако если вы выбрали учетные записи в любом каталоге организации (любой каталог идентификатора Microsoft Entra — мультитенантные и личные учетные записи Майкрософт, например Xbox, Outlook.com) или учетные записи в любом каталоге организации (каталог Microsoft Entra ID — Мультитенант), введите common вместо идентификатора клиента. В противном случае, приложение Microsoft Entra ID проверит посредством клиента, идентификатор которого выбран, и исключит личные учетные записи Майкрософт.

      Данный арендатор будет связан с пользователями, которые могут подтвердить свою подлинность. Для получения дополнительной информации см. Тенантство в Microsoft Entra ID.

   7. Для областей введите имена разрешений, которые вы выбрали при регистрации приложения. Для тестирования можно просто ввести: openid profile

      Примечание.

      Для идентификатора Microsoft Entra ID поле Области принимает список значений, учитывающий регистр и разделенный пробелами.

5. Выберите Сохранить.

1. Перейдите на страницу ресурсов бота на портал Azure.

2. Выберите Параметры.

3. В разделе "Параметры подключения OAuth" в нижней части страницы выберите "Добавить параметр".

4. Заполните форму следующим образом.

   1. В поле Имя введите имя подключения, это имя будет использовано в коде вашего бота.

   2. Для поставщика услуг выберите идентификатор Microsoft Entra. После того как вы выберете это, будут отображаться поля, специфичные для идентификатора Microsoft Entra.

   3. В поле Идентификатор клиента введите идентификатор приложения (клиента), который вы записали для приложения Azure AD версии 1.

   4. Для секрета клиента введите секрет, созданный для предоставления боту доступа к приложению идентификатора Microsoft Entra.

   5. В поле Тип предоставления разрешения введите authorization_code.

   6. В поле URL-адрес входа введите https://login.microsoftonline.com.

   7. Для идентификатора арендатора введите идентификатор каталога (арендатора), который вы записали ранее для приложения Microsoft Entra ID или common, в зависимости от поддерживаемых типов учетных записей, выбранных при создании приложения ADD. Чтобы решить, какое значение следует назначить, выполните следующие критерии:

      • При создании приложения Microsoft Entra ID, если вы выбрали учетные записи только в этом каталоге организации (только Майкрософт — один клиент), введите идентификатор арендатора, который вы записали ранее для приложения Microsoft Entra ID.
      • Однако если вы выбрали учетные записи в любом каталоге организации (любой каталог идентификатора Microsoft Entra — мультитенантные и личные учетные записи Майкрософт, например Xbox, Outlook.com) или учетные записи в любом каталоге организации (каталог Microsoft Entra ID — Мультитенант), введите common вместо идентификатора клиента. В противном случае приложение Microsoft Entra ID произведет проверку через клиента, идентификатор которого был выбран, и исключит персональные учетные записи Microsoft.

      Данный арендатор будет связан с пользователями, которые могут подтвердить свою подлинность. Для получения дополнительной информации см. Тенантство в Microsoft Entra ID.

   8. Для параметра URL-адрес ресурса введите https://graph.microsoft.com/.

   9. Оставите поле Области пустым.

5. Выберите Сохранить.

1. Клонируйте из репозитория GitHub пример, с которым вы хотите работать: проверка подлинности бота или проверка подлинности бота для Microsoft Graph.

2. Обновите файл appsettings.json:

   • Присвойте параметру ConnectionName имя настройки подключения OAuth, которое вы добавили в своего бота.

   • параметрам MicrosoftAppId и MicrosoftAppPassword присвойте значения идентификатора приложения бота и секрета приложения.

     В зависимости от символов, из которых состоит секрет бота, может потребоваться экранирование пароля в формате XML. Например, символ амперсанда (&) потребуется кодировать как &.

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

   Чтобы использовать OAuth в боте с размещением данных в общедоступном облаке, необходимо добавить в приложения следующие конфигурации.

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

   Где <Regional-OAuth-Url> является одним из следующих URI:

   URI	Описание
   https://europe.api.botframework.com	Для публичных облачных ботов с хранением данных в Европе.
   https://unitedstates.api.botframework.com	Для ботов, работающих в общедоступной облачной среде, с местоположением данных в США.
   https://india.api.botframework.com	Для общедоступных облачных ботов с размещением данных в Индии.

3. Обновление Startup.cs:

   Чтобы использовать OAuth в недоступных облаках Azure, таких как облако для государственных организаций, необходимо добавить следующий код в файл Startup.cs .

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

   Где <uri-to-use> — один из следующих URI:

   URI	Описание
   https://api.botframework.azure.us	Для облачных ботов правительства США без привязки к местоположению данных.
   https://api.botframework.com	Для общедоступных облачных ботов без требования размещения данных. Это идентификатор ресурса (URI) по умолчанию и не требует изменения в Startup.cs.

1. Клонируйте из репозитория GitHub, с которым вы хотите работать: проверка подлинности бота или проверка подлинности бота для Microsoft Graph.

2. Обновите файл с расширением .env:

   • Присвойте параметру connectionName имя настройки подключения OAuth, которое вы добавили в своего бота.

   • параметрам MicrosoftAppId и MicrosoftAppPassword присвойте значения идентификатора приложения бота и секрета приложения.

     В зависимости от символов, из которых состоит секрет бота, может потребоваться XML-экранирование пароля. Например, символ амперсанда (&) потребуется кодировать как &.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. Клонируйте из репозитория GitHub пример, с которым вы хотите работать: проверка подлинности бота или проверка подлинности бота для Microsoft Graph.

2. Обновление application.properties:

   • Присвойте параметру ConnectionName имя настройки подключения OAuth, которое вы добавили в своего бота.
   • параметрам MicrosoftAppId и MicrosoftAppPassword присвойте значения идентификатора приложения бота и секрета приложения.

   Предупреждение

   Похоже, пример, который вы ищете, был перемещён! Будьте уверены, что мы работаем над решением этого.

1. Клонируйте нужный вам репозиторий GitHub: проверка подлинности или проверка подлинности бота для Microsoft Graph.

2. Обновите config.py:

   • Присвойте параметру ConnectionName имя настройки подключения OAuth, которое вы добавили в своего бота.

   • параметрам MicrosoftAppId и MicrosoftAppPassword присвойте значения идентификатора приложения бота и секрета приложения.

     В зависимости от символов, из которых состоит секрет бота, может потребоваться XML-экранирование пароля. Например, символ амперсанда (&) потребуется кодировать как &.

   #!/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", "")
   

Диалоговые окна\MainDialog.cs

Добавьте запрос OAuth в MainDialog с помощью конструктора. Здесь мы получаем значение имени подключения из файла 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)
    }));

В шаге диалога укажите BeginDialogAsync для запуска командной строки OAuth, в которой пользователю будет предложено войти в систему.

• Если пользователь уже выполнил вход, будет сгенерировано событие ответа токена без запроса у пользователя.
• В противном случае пользователю будет предложено войти в систему. Azure AI Служба Bot отправляет событие ответа с токеном после попытки входа пользователя.

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

В следующем шаге диалога проверьте наличие маркера в результате, полученном от предыдущего шага. Если он не имеет значения NULL, пользователь успешно вошел в систему.

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

диалоговые окна/mainDialog.js

Добавьте запрос OAuth в MainDialog с помощью конструктора. В этом примере значение имени подключения получено из файла с расширением .env.

}));
this.addDialog(new ConfirmPrompt(CONFIRM_PROMPT));
this.addDialog(new WaterfallDialog(MAIN_WATERFALL_DIALOG, [
    this.promptStep.bind(this),
    this.loginStep.bind(this),
    this.displayTokenPhase1.bind(this),

В шаге диалога укажите beginDialog для запуска командной строки OAuth, в которой пользователю будет предложено войти в систему.

• Если пользователь уже выполнил вход, будет сгенерировано событие ответа токена без запроса у пользователя.
• В противном случае пользователю будет предложено войти в систему. Azure AI Служба Bot отправляет событие ответа с токеном после попытки входа пользователя.

// Get the token from the previous step. Note that we could also have gotten the

В следующем шаге диалога проверьте наличие маркера в результате, полученном от предыдущего шага. Если он не имеет значения NULL, пользователь успешно вошел в систему.

    return await stepContext.prompt(CONFIRM_PROMPT, 'Would you like to view your token?');
}

MainDialog.java

Добавьте запрос OAuth в MainDialog с помощью конструктора. Здесь значение имени подключения получено из файла application.properties .

В шаге диалога укажите beginDialog для запуска командной строки OAuth, в которой пользователю будет предложено войти в систему.

• Если пользователь уже выполнил вход, будет сгенерировано событие ответа токена без запроса у пользователя.
• В противном случае пользователю будет предложено войти в систему. Azure AI Служба Bot отправляет событие ответа с токеном после попытки входа пользователя.

В следующем шаге диалога проверьте наличие маркера в результате, полученном от предыдущего шага. Если он не имеет значения NULL, пользователь успешно вошел в систему.

dialogs/main_dialog.py

Добавьте запрос OAuth в MainDialog с помощью конструктора. В этом примере значение имени подключения получено из файла config.py.

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

В шаге диалога укажите begin_dialog для запуска командной строки OAuth, в которой пользователю будет предложено войти в систему.

• Если пользователь уже выполнил вход, будет сгенерировано событие ответа токена без запроса у пользователя.
• В противном случае пользователю будет предложено войти в систему. Azure AI Служба Bot отправляет событие ответа с токеном после попытки входа пользователя.

return await step_context.begin_dialog(OAuthPrompt.__name__)

В следующем шаге диалога проверьте наличие маркера в результате, полученном от предыдущего шага. Если он не имеет значения NULL, пользователь успешно вошел в систему.

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 наследуется от ActivityHandler и явным образом обрабатывает события ответа токена. Здесь мы продолжаем активный диалог, что позволяет командной строке OAuth обработать событие и получить маркер.

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 наследуется от ActivityHandler и явным образом обрабатывает события ответа токена. Здесь мы продолжаем активный диалог, что позволяет командной строке OAuth обработать событие и получить маркер.

    await next();
});

AuthBot.java

AuthBot наследуется от Dialog и явным образом обрабатывает события ответа токена. Здесь мы продолжаем активный диалог, что позволяет командной строке OAuth обработать событие и получить маркер.

bots/auth_bot.py

AuthBot явно обрабатывает события ответа токена. Здесь мы продолжаем активный диалог, что позволяет командной строке OAuth обработать событие и получить маркер.

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

Диалоговые окна\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;
}

диалоговые окна/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

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(