Přidání ověřování do robota

K dispozici pro roboty jazyka C#, JavaScript a Python.

K dispozici pro roboty jazyka C#, JavaScript a Python.

K dispozici pro roboty ve všech programovacích jazycích: C#, JavaScript, Java a Python.

1. Na webu Azure Portal otevřete stránku prostředku robota Azure Bot vašeho robota.

2. Vyberte Nastavení.

3. V části Nastavení připojení OAuth v dolní části stránky vyberte Přidat nastavení.

4. Vyplňte formulář následujícím způsobem:

   1. Název. Zadejte název připojení. Použijete ho v kódu robota.

   2. Poskytovatel služeb. Vyberte Microsoft Entra ID , aby se zobrazila pole specifická pro ID Microsoft Entra.

   3. ID klienta. Zadejte ID aplikace (klienta), které jste si poznamenali pro zprostředkovatele identity Microsoft Entra ID.

   4. Tajný klíč klienta. Zadejte tajný klíč, který jste si poznamenali pro zprostředkovatele identity Microsoft Entra ID.

      Tip

      Pokud chcete použít certifikáty, můžete vybrat AAD v2 s poskytovatelem certifikátů . Budete muset udělit úložiště tokenů služby Bot Service (appid: 5b404cf4-a79d-4cfe-b866-24bf8e1a4921) oprávnění k získání certifikátu.

   5. Adresa URL výměny tokenů Nechte ho prázdné, protože se používá jenom pro jednotné přihlašování v Microsoft Entra ID.

   6. ID tenanta. Zadejte ID adresáře (tenanta), které jste si poznamenali dříve pro aplikaci Microsoft Entra ID, nebo běžné v závislosti na podporovaných typech účtů vybraných při vytváření aplikace Azure DD. Pokud se chcete rozhodnout, kterou hodnotu chcete přiřadit, postupujte podle těchto kritérií:

      • Pokud jste při vytváření aplikace Microsoft Entra ID vybrali jenom účty v tomto organizačním adresáři (jenom Microsoft – jeden tenant), zadejte ID tenanta, které jste si poznamenali dříve pro aplikaci Microsoft Entra ID.
      • Pokud jste ale vybrali účty v libovolném adresáři organizace (libovolný adresář Microsoft Entra ID – více tenantů a osobní účty Microsoft, například Xbox, Outlook.com) nebo Účty v libovolném adresáři organizace (adresář Microsoft Entra ID – Více tenantů), zadejte common místo ID tenanta. Jinak aplikace Microsoft Entra ID ověří prostřednictvím tenanta, jehož ID bylo vybráno a vyloučeno osobní účty Microsoft.

      Toto bude tenant přidružený k uživatelům, kteří se můžou ověřit. Další informace naleznete v tématu Tenantancy v Microsoft Entra ID.

   7. V části Obory zadejte názvy oprávnění, které jste zvolili při registraci aplikace. Pro účely testování stačí zadat: openid profile.

      Poznámka:

      Pole Obory v poli Microsoft Entra ID přebírá seznam hodnot oddělených písmeny s rozlišováním velkých a malých písmen.

5. Zvolte Uložit.

1. Na webu Azure Portal přejděte na stránku prostředků vašeho robota.

2. Vyberte Nastavení.

3. V části Nastavení připojení OAuth v dolní části stránky vyberte Přidat nastavení.

4. Vyplňte formulář následujícím způsobem:

   1. Jako Název zadejte název připojení. Tento název použijete v kódu robota.

   2. Pro poskytovatele služeb vyberte Microsoft Entra ID. Jakmile tuto možnost vyberete, zobrazí se pole specifická pro ID microsoftu Entra.

   3. Jako ID klienta zadejte ID aplikace (klienta), které jste si poznamenali pro aplikaci Azure AD v1.

   4. Jako tajný klíč klienta zadejte tajný klíč, který jste vytvořili, aby robotovi udělil přístup k aplikaci Microsoft Entra ID.

   5. Jako typ grantu zadejte authorization_code.

   6. Jako přihlašovací adresu URL zadejte https://login.microsoftonline.com.

   7. Jako ID tenanta zadejte ID adresáře (tenanta), které jste si poznamenali dříve pro aplikaci Microsoft Entra ID, nebo běžné v závislosti na podporovaných typech účtů vybraných při vytváření aplikace ADD. Pokud se chcete rozhodnout, kterou hodnotu chcete přiřadit, postupujte podle těchto kritérií:

      • Pokud jste při vytváření aplikace Microsoft Entra ID vybrali jenom účty v tomto organizačním adresáři (jenom Microsoft – jeden tenant), zadejte ID tenanta, které jste si poznamenali dříve pro aplikaci Microsoft Entra ID.
      • Pokud jste ale vybrali účty v libovolném adresáři organizace (libovolný adresář Microsoft Entra ID – více tenantů a osobní účty Microsoft, například Xbox, Outlook.com) nebo Účty v libovolném adresáři organizace (adresář Microsoft Entra ID – Více tenantů), zadejte common místo ID tenanta. Jinak aplikace Microsoft Entra ID ověří prostřednictvím tenanta, jehož ID bylo vybráno a vyloučeno osobní účty MS.

      Toto bude tenant přidružený k uživatelům, kteří se můžou ověřit. Další informace naleznete v tématu Tenantancy v Microsoft Entra ID.

   8. Do pole Adresa URL zdroje zadejte https://graph.microsoft.com/.

   9. Ponechte obory prázdné.

5. Zvolte Uložit.

1. Naklonujte z úložiště GitHub ukázku, se kterou chcete pracovat: Ověřování robota nebo ověřování robota pro Microsoft Graph.

2. Aktualizovat appsettings.json:

   • Nastavte ConnectionName na název nastavení připojení OAuth, které jste přidali do robota.

   • Nastavte a MicrosoftAppPassword nastavte MicrosoftAppId ID aplikace vašeho robota a tajný klíč aplikace.

     V závislosti na znaménech znaků v tajném kódu robota možná budete muset utéct heslem XML. Například všechny ampersandy (&) budou muset být kódovány jako &.

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

   Pokud chcete používat OAuth v robotovi s rezidencí dat ve veřejném cloudu, musíte do nastavení aplikace přidat následující konfigurace.

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

   Kde <Regional-OAuth-Url> je jedna z následujících identifikátorů URI:

   Identifikátor URI	Popis
   https://europe.api.botframework.com	Pro roboty veřejného cloudu s rezidencí dat v Evropě.
   https://unitedstates.api.botframework.com	Pro roboty veřejného cloudu s rezidencí dat v USA.
   https://india.api.botframework.com	Pro roboty veřejného cloudu s rezidencí dat v Indii.

3. Aktualizovat Startup.cs:

   Pokud chcete použít OAuth v nepřístupných cloudech Azure, jako je cloud státní správy, musíte do souboru Startup.cs přidat následující kód.

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

   Kde <uri-to-use> je jedna z následujících identifikátorů URI:

   Identifikátor URI	Popis
   https://api.botframework.azure.us	Pro USA roboty cloudu pro státní správu bez rezidence dat.
   https://api.botframework.com	Pro roboty veřejného cloudu bez rezidence dat. Toto je výchozí identifikátor URI a nevyžaduje změnu Startup.cs.

1. Klonujte z úložiště GitHub, se kterým chcete pracovat: Ověřování robota nebo ověřování robota pro Microsoft Graph.

2. Aktualizovat .env:

   • Nastavte connectionName na název nastavení připojení OAuth, které jste přidali do robota.

   • Nastavte MicrosoftAppId a MicrosoftAppPassword hodnoty na ID aplikace a tajný klíč aplikace robota.

     V závislosti na znaménech znaků v tajném kódu robota možná budete muset utéct heslem XML. Například všechny ampersandy (&) budou muset být kódovány jako &.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. Naklonujte z úložiště GitHub ukázku, se kterou chcete pracovat: Ověřování robota nebo ověřování robota pro Microsoft Graph.

2. Aktualizovat application.properties:

   • Nastavte ConnectionName na název nastavení připojení OAuth, které jste přidali do robota.
   • Nastavte a MicrosoftAppPassword nastavte MicrosoftAppId ID aplikace vašeho robota a tajný klíč aplikace.

   MicrosoftAppId=
   MicrosoftAppPassword=
   server.port=3978
   ConnectionName=
   

1. Naklonujte úložiště GitHubu ukázku, se kterou chcete pracovat: Ověřování robota nebo ověřování robota pro Microsoft Graph.

2. Aktualizovat config.py:

   • Nastavte ConnectionName na název nastavení připojení OAuth, které jste přidali do robota.

   • Nastavte a MicrosoftAppPassword nastavte MicrosoftAppId ID aplikace vašeho robota a tajný klíč aplikace.

     V závislosti na znaménech znaků v tajném kódu robota možná budete muset utéct heslem XML. Například všechny ampersandy (&) budou muset být kódovány jako &.

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

Dialogy\MainDialog.cs

V jeho konstruktoru přidejte výzvu OAuth do MainDialogu . V této části se z appsettings.json souboru načetla hodnota názvu připojení.

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

V rámci kroku dialogového okna spusťte BeginDialogAsync výzvu OAuth, která uživatele vyzve k přihlášení.

• Pokud je uživatel již přihlášený, vygeneruje se událost odpovědi tokenu bez výzvy uživatele.
• V opačném případě se uživateli zobrazí výzva k přihlášení. Služba Azure AI Bot Service odešle událost odpovědi tokenu po pokusu uživatele o přihlášení.

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

V následujícím dialogovém okně zkontrolujte přítomnost tokenu ve výsledku z předchozího kroku. Pokud není null, uživatel se úspěšně přihlásil.

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

dialogy/mainDialog.js

V jeho konstruktoru přidejte výzvu OAuth do MainDialogu . Zde byla načtena hodnota pro název připojení ze souboru .env .

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

V rámci kroku dialogového okna spusťte beginDialog výzvu OAuth, která uživatele vyzve k přihlášení.

• Pokud je uživatel již přihlášený, vygeneruje se událost odpovědi tokenu bez výzvy uživatele.
• V opačném případě se uživateli zobrazí výzva k přihlášení. Služba Azure AI Bot Service odešle událost odpovědi tokenu po pokusu uživatele o přihlášení.

const tokenResponse = stepContext.result;

V následujícím dialogovém okně zkontrolujte přítomnost tokenu ve výsledku z předchozího kroku. Pokud není null, uživatel se úspěšně přihlásil.

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

MainDialog.java

V jeho konstruktoru přidejte výzvu OAuth do MainDialogu . V této části se z souboru application.properties načetla hodnota názvu připojení.

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

V rámci kroku dialogového okna spusťte beginDialog výzvu OAuth, která uživatele vyzve k přihlášení.

• Pokud je uživatel již přihlášený, vygeneruje se událost odpovědi tokenu bez výzvy uživatele.
• V opačném případě se uživateli zobrazí výzva k přihlášení. Služba Azure AI Bot Service odešle událost odpovědi tokenu po pokusu uživatele o přihlášení.

return stepContext.beginDialog("OAuthPrompt");

V následujícím dialogovém okně zkontrolujte přítomnost tokenu ve výsledku z předchozího kroku. Pokud není null, uživatel se úspěšně přihlásil.

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

dialogy/main_dialog.py

V jeho konstruktoru přidejte výzvu OAuth do MainDialogu . Tady se z config.py souboru načetla hodnota názvu připojení.

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

V rámci kroku dialogového okna spusťte begin_dialog výzvu OAuth, která uživatele vyzve k přihlášení.

• Pokud je uživatel již přihlášený, vygeneruje se událost odpovědi tokenu bez výzvy uživatele.
• V opačném případě se uživateli zobrazí výzva k přihlášení. Služba Azure AI Bot Service odešle událost odpovědi tokenu po pokusu uživatele o přihlášení.

return await step_context.begin_dialog(OAuthPrompt.__name__)

V následujícím dialogovém okně zkontrolujte přítomnost tokenu ve výsledku z předchozího kroku. Pokud není null, uživatel se úspěšně přihlásil.

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

Roboti\AuthBot.cs

AuthBot odvozuje ActivityHandler a explicitně zpracovává aktivity událostí odpovědi na tokeny. Tady pokračujeme v aktivním dialogovém okně, které umožňuje výzvě OAuth zpracovat událost a načíst 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);
}

roboti/authBot.js

AuthBot odvozuje ActivityHandler a explicitně zpracovává aktivity událostí odpovědi na tokeny. Tady pokračujeme v aktivním dialogovém okně, které umožňuje výzvě OAuth zpracovat událost a načíst token.

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

await next();

AuthBot.java

AuthBot odvozuje Dialog a explicitně zpracovává aktivity událostí odpovědi na tokeny. Tady pokračujeme v aktivním dialogovém okně, které umožňuje výzvě OAuth zpracovat událost a načíst 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"));
}

roboti/auth_bot.py

AuthBot explicitně zpracovává aktivity událostí odpovědi na tokeny. Tady pokračujeme v aktivním dialogovém okně, které umožňuje výzvě OAuth zpracovat událost a načíst 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"),
    )

Dialogy\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;
}

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

dialogy/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(