Lägga till autentisering i en robot

Tillgänglig för C#-, JavaScript- och Python-robotar.

Tillgänglig för C#-, JavaScript- och Python-robotar.

Tillgänglig för robotar på alla programmeringsspråk: C#, JavaScript, Java och Python.

1. Öppna robotens Resurssida för Azure Bot i Azure-portalen.

2. Välj Inställningar.

3. Under OAuth-anslutningsinställningar längst ned på sidan väljer du Lägg till inställning.

4. Fyll i formuläret på följande sätt:

   1. Namn. Ange ett namn för anslutningen. Du använder den i robotkoden.

   2. Tjänstleverantör. Välj Microsoft Entra-ID för att visa Microsoft Entra ID-specifika fält.

   3. Klient-ID. Ange det program-ID (klient)-ID som du registrerade för din Microsoft Entra ID-identitetsprovider.

   4. Klienthemlighet. Ange hemligheten som du registrerade för din Microsoft Entra ID-identitetsprovider.

      Dricks

      Om du vill använda certifikat kan du välja AAD v2 med certifikatprovidern . Du måste ge Bot Service Token Store (appid: 5b404cf4-a79d-4cfe-b866-24bf8e1a4921) behörighet att hämta certifikatet.

   5. Token Exchange URL. Lämna det tomt eftersom det endast används för enkel inloggning i Microsoft Entra-ID.

   6. Klientorganisations-ID. Ange det katalog-ID (klient)-ID som du registrerade tidigare för din Microsoft Entra-ID-app eller vanligt beroende på vilka kontotyper som stöds som valdes när du skapade Azure DD-appen. Följ dessa kriterier för att bestämma vilket värde som ska tilldelas:

      • När du skapar Microsoft Entra-ID-appen anger du det klient-ID som du registrerade tidigare för Microsoft Entra-ID-appen om du valde Endast Konton i den här organisationskatalogen (endast Microsoft – enskild klientorganisation).
      • Men om du har valt Konton i någon organisationskatalog (Microsoft Entra-ID-katalog – Flera klient- och personliga Microsoft-konton, t.ex. Xbox, Outlook.com) eller Konton i en organisationskatalog (Microsoft Entra ID-katalog – Flera klientorganisationer), anger du common i stället för ett klient-ID. Annars verifierar Microsoft Entra-ID-appen via klientorganisationen vars ID har valts och exkluderar personliga Microsoft-konton.

      Det här är den klientorganisation som är associerad med de användare som kan autentiseras. Mer information finns i Innehavare i Microsoft Entra-ID.

   7. För Omfång anger du namnen på den behörighet som du valde från programregistreringen. I testsyfte kan du bara ange: openid profile.

      Kommentar

      För Microsoft Entra-ID tar fältet Scopes en skiftlägeskänslig , utrymmesavgränsad lista med värden.

5. Välj Spara.

1. Gå till robotens resurssida på Azure-portalen.

2. Välj Inställningar.

3. Under OAuth-anslutningsinställningar längst ned på sidan väljer du Lägg till inställning.

4. Fyll i formuläret på följande sätt:

   1. Som Namn anger du ett namn för anslutningen. Du använder det här namnet i robotkoden.

   2. Som tjänstleverantör väljer du Microsoft Entra-ID. När du har valt detta visas de Microsoft Entra-ID-specifika fälten.

   3. För Klient-ID anger du det program-ID (klient)-ID som du registrerade för ditt Azure AD v1-program.

   4. För Klienthemlighet anger du hemligheten som du skapade för att ge roboten åtkomst till Microsoft Entra-ID-appen.

   5. För Bevilja typ anger du authorization_code.

   6. För Inloggnings-URL anger du https://login.microsoftonline.com.

   7. För Klientorganisations-ID anger du det katalog-ID (klient)-ID som du registrerade tidigare för din Microsoft Entra-ID-app eller vanligt beroende på vilka kontotyper som stöds som valdes när du skapade ADD-appen. Följ dessa kriterier för att bestämma vilket värde som ska tilldelas:

      • När du skapar Microsoft Entra-ID-appen anger du det klient-ID som du registrerade tidigare för Microsoft Entra-ID-appen om du valde Endast Konton i den här organisationskatalogen (endast Microsoft – enskild klientorganisation).
      • Men om du har valt Konton i någon organisationskatalog (Microsoft Entra-ID-katalog – Flera klient- och personliga Microsoft-konton, t.ex. Xbox, Outlook.com) eller Konton i en organisationskatalog (Microsoft Entra ID-katalog – Flera klientorganisationer), anger du common i stället för ett klient-ID. Annars verifierar Microsoft Entra-ID-appen via klientorganisationen vars ID har valts och exkluderar personliga MS-konton.

      Det här är den klientorganisation som är associerad med de användare som kan autentiseras. Mer information finns i Innehavare i Microsoft Entra-ID.

   8. För Resurs-URL, ange https://graph.microsoft.com/.

   9. Lämna omfången tomma.

5. Välj Spara.

1. Klona från GitHub-lagringsplatsen det exempel som du vill arbeta med: Robotautentisering eller robotautentisering för Microsoft Graph.

2. Uppdatera appsettings.json:

   • Ange ConnectionName namnet på den OAuth-anslutningsinställning som du lade till i roboten.

   • Ange MicrosoftAppId och MicrosoftAppPassword till robotens app-ID och apphemlighet.

     Beroende på tecknen i robothemligheten kan du behöva undvika lösenordet för XML. Till exempel måste alla &ers (&) kodas som &.

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

   Om du vill använda OAuth i roboten med datahemvist i det offentliga molnet måste du lägga till följande konfigurationer i dina apparinställningar

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

   Där <Regional-OAuth-Url> är en av följande URI:er:

   URI	beskrivning
   https://europe.api.botframework.com	För offentliga molnrobotar med datahemvist i Europa.
   https://unitedstates.api.botframework.com	För offentliga molnrobotar med datahemvist i USA.
   https://india.api.botframework.com	För offentliga molnrobotar med datahemvist i Indien.

3. Uppdatera Startup.cs:

   Om du vill använda OAuth i icke-offentliga Azure-moln, till exempel myndighetsmolnet, måste du lägga till följande kod i filen Startup.cs .

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

   Där <uri-to-use> är en av följande URI:er:

   URI	beskrivning
   https://api.botframework.azure.us	För amerikanska myndighetsmolnrobotar utan datahemvist.
   https://api.botframework.com	För offentliga molnrobotar utan datahemvist. Detta är standard-URI:n och kräver ingen ändring av Startup.cs.

1. Klona från den GitHub-lagringsplats som du vill arbeta med: Robotautentisering eller robotautentisering för Microsoft Graph.

2. Uppdatera .env:

   • Ange connectionName namnet på den OAuth-anslutningsinställning som du lade till i roboten.

   • Ange MicrosoftAppId och MicrosoftAppPassword värden för robotens app-ID och apphemlighet.

     Beroende på tecknen i robothemligheten kan du behöva undvika lösenordet för XML. Till exempel måste alla &ers (&) kodas som &.

   MicrosoftAppType=
   MicrosoftAppId=
   MicrosoftAppPassword=
   MicrosoftAppTenantId=
   connectionName=
   

1. Klona från GitHub-lagringsplatsen det exempel som du vill arbeta med: Robotautentisering eller robotautentisering för Microsoft Graph.

2. Uppdatera application.properties:

   • Ange ConnectionName namnet på den OAuth-anslutningsinställning som du lade till i roboten.
   • Ange MicrosoftAppId och MicrosoftAppPassword till robotens app-ID och apphemlighet.

   MicrosoftAppId=
   MicrosoftAppPassword=
   server.port=3978
   ConnectionName=
   

1. Klona GitHub-lagringsplatsen som du vill arbeta med: Robotautentisering eller robotautentisering för Microsoft Graph.

2. Uppdatera config.py:

   • Ange ConnectionName namnet på den OAuth-anslutningsinställning som du lade till i roboten.

   • Ange MicrosoftAppId och MicrosoftAppPassword till robotens app-ID och apphemlighet.

     Beroende på tecknen i robothemligheten kan du behöva undvika lösenordet för XML. Till exempel måste alla &ers (&) kodas som &.

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

Dialogrutor\MainDialog.cs

Lägg till en OAuth-prompt till MainDialog i konstruktorn. Här hämtades värdet för anslutningsnamnet från filen 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)
    }));

I ett dialogsteg använder du BeginDialogAsync för att starta OAuth-prompten, som ber användaren att logga in.

• Om användaren redan är inloggad genereras en tokensvarshändelse utan att användaren uppmanas att göra det.
• Annars uppmanas användaren att logga in. Azure AI Bot Service skickar tokensvarshändelsen när användaren försöker logga in.

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

I följande dialogsteg kontrollerar du om det finns en token i resultatet från föregående steg. Om den inte är null har användaren loggat in.

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

dialogrutor/mainDialog.js

Lägg till en OAuth-prompt till MainDialog i konstruktorn. Här hämtades värdet för anslutningsnamnet från .env-filen .

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

I ett dialogsteg använder du beginDialog för att starta OAuth-prompten, som ber användaren att logga in.

• Om användaren redan är inloggad genereras en tokensvarshändelse utan att användaren uppmanas att göra det.
• Annars uppmanas användaren att logga in. Azure AI Bot Service skickar tokensvarshändelsen när användaren försöker logga in.

const tokenResponse = stepContext.result;

I följande dialogsteg kontrollerar du om det finns en token i resultatet från föregående steg. Om den inte är null har användaren loggat in.

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

MainDialog.java

Lägg till en OAuth-prompt till MainDialog i konstruktorn. Här hämtades värdet för anslutningsnamnet från filen 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));

I ett dialogsteg använder du beginDialog för att starta OAuth-prompten, som ber användaren att logga in.

• Om användaren redan är inloggad genereras en tokensvarshändelse utan att användaren uppmanas att göra det.
• Annars uppmanas användaren att logga in. Azure AI Bot Service skickar tokensvarshändelsen när användaren försöker logga in.

return stepContext.beginDialog("OAuthPrompt");

I följande dialogsteg kontrollerar du om det finns en token i resultatet från föregående steg. Om den inte är null har användaren loggat in.

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

dialogrutor/main_dialog.py

Lägg till en OAuth-prompt till MainDialog i konstruktorn. Här hämtades värdet för anslutningsnamnet från filen config.py .

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

I ett dialogsteg använder du begin_dialog för att starta OAuth-prompten, som ber användaren att logga in.

• Om användaren redan är inloggad genereras en tokensvarshändelse utan att användaren uppmanas att göra det.
• Annars uppmanas användaren att logga in. Azure AI Bot Service skickar tokensvarshändelsen när användaren försöker logga in.

return await step_context.begin_dialog(OAuthPrompt.__name__)

I följande dialogsteg kontrollerar du om det finns en token i resultatet från föregående steg. Om den inte är null har användaren loggat in.

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

Robotar\AuthBot.cs

AuthBot härleder från ActivityHandler och hanterar uttryckligen händelseaktiviteter för tokensvar. Här fortsätter vi den aktiva dialogrutan, vilket gör att OAuth-prompten kan bearbeta händelsen och hämta 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);
}

robotar/authBot.js

AuthBot härleder från ActivityHandler och hanterar uttryckligen händelseaktiviteter för tokensvar. Här fortsätter vi den aktiva dialogrutan, vilket gör att OAuth-prompten kan bearbeta händelsen och hämta token.

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

await next();

AuthBot.java

AuthBot härleder från Dialog och hanterar uttryckligen händelseaktiviteter för tokensvar. Här fortsätter vi den aktiva dialogrutan, vilket gör att OAuth-prompten kan bearbeta händelsen och hämta 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"));
}

robotar/auth_bot.py

AuthBot hanterar uttryckligen händelseaktiviteter för tokensvar. Här fortsätter vi den aktiva dialogrutan, vilket gör att OAuth-prompten kan bearbeta händelsen och hämta 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"),
    )

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

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

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