SkillValidation Klasse

  • Referenz
Paket:
com.microsoft.bot.connector.authentication
Maven-Artefakt:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.connector.authentication.SkillValidation

public final class SkillValidation

Überprüft JWT-Token, die an und von einer Fähigkeit gesendet werden.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateChannelToken(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, AuthenticationConfiguration authConfig)

Überprüft, ob der eingehende Authentifizierungsheader ein Token ist, das von einem Bot an eine Fähigkeit oder von einer Fähigkeit an einen Bot gesendet wird.
static ClaimsIdentity createAnonymousSkillClaim()

Erstellt eine Anspruchs-Identität für eine anonyme (nicht authentifizierte) Fähigkeit.
static java.lang.Boolean isSkillClaim(Map<String,String> claims)

Überprüft, ob die angegebene Liste von Ansprüchen eine Fähigkeit darstellt.
static boolean isSkillToken(String authHeader)

Bestimmt, ob ein bestimmter Authentifizierungsheader von einer Fähigkeit zu Bot oder Bot zur Qualifikationsanforderung stammt.
static java.util.concurrent.CompletableFuture<java.lang.Void> validateIdentity(ClaimsIdentity identity, CredentialProvider credentials)

Hilfsprogramm zum Überprüfen einer QualifikationsansprücheIdentität.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Details zur Methode

authenticateChannelToken

public static CompletableFuture authenticateChannelToken(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, AuthenticationConfiguration authConfig)

Überprüft, ob der eingehende Authentifizierungsheader ein Token ist, das von einem Bot an eine Fähigkeit oder von einer Fähigkeit an einen Bot gesendet wird.

Parameter:

authHeader - Der unformatierte HTTP-Header im Format": "Bearer [longString]".
credentials - Der benutzerdefinierte Satz gültiger Anmeldeinformationen, z. B. die AppId.
channelProvider - Der ChannelService-Wert, der öffentliche Azure von US Government Azure unterscheidet.
channelId - Die ID des zu überprüfenden Kanals.
authConfig - Die Authentifizierungskonfiguration.

Gibt zurück:

Eine ClaimsIdentity Instanz, wenn die Überprüfung erfolgreich ist.

createAnonymousSkillClaim

public static ClaimsIdentity createAnonymousSkillClaim()

Erstellt eine ClaimsIdentity für eine anonyme (nicht authentifizierte) Fähigkeit.

Gibt zurück:

Eine ClaimsIdentity-Instanz mit Authentifizierungstyp, der auf AuthenticationConstants.AnonymousAuthType und einen reservierten AuthenticationConstants.AnonymousSkillAppId-Anspruch festgelegt ist.

isSkillClaim

public static Boolean isSkillClaim(Map claims)

Überprüft, ob die angegebene Liste von Ansprüchen eine Fähigkeit darstellt. Ein Qualifikationsanspruch sollte folgendes enthalten: ein VERSION_CLAIM Anspruch. Ein AuthenticationConstants.AUTIENCE_CLAIM Anspruch. Ein APPID_CLAIM Anspruch (v1) oder ein AUTHORIZED_PARTY Anspruch (v2). Und der AppId-Anspruch sollte sich von dem Zielgruppenanspruch unterscheiden. Wenn ein Kanal (Webchat, Teams usw.) einen Bot aufruft, wird die AuthenticationConstants.AUTIENCE_CLAIM auf TO_BOT_FROM_CHANNEL_TOKEN_ISSUER festgelegt, aber wenn ein Bot einen anderen Bot aufruft, wird der Zielgruppenanspruch auf die appId des aufgerufenen Bots festgelegt. Das Protokoll unterstützt v1- und v2-Token: Bei v1-Token ist die APPID_CLAIM vorhanden und auf die App-ID des aufrufenden Bots festgelegt. Bei v2-Token ist die AUTHORIZED_PARTY vorhanden und auf die App-ID des aufrufenden Bots festgelegt.

Parameter:

claims - Eine Liste von Ansprüchen.

Gibt zurück:

True, wenn die Liste der Ansprüche ein Qualifikationsanspruch ist, "false", wenn dies nicht der Fall ist.

isSkillToken

public static boolean isSkillToken(String authHeader)

Bestimmt, ob ein bestimmter Authentifizierungsheader von einer Fähigkeit zu Bot oder Bot zur Qualifikationsanforderung stammt.

Parameter:

authHeader - Bearertoken im Format "Bearer [Long String]"

Gibt zurück:

True, wenn das Token für eine Fähigkeit zur Bot-Kommunikation ausgestellt wurde. Andernfalls "false".

validateIdentity

public static CompletableFuture validateIdentity(ClaimsIdentity identity, CredentialProvider credentials)

Hilfsprogramm zum Überprüfen einer "ClaimsIdentity"-Fähigkeit.

Parameter:

identity - Die zu überprüfende ClaimsIdentity.The ClaimsIdentity to validate.
credentials - Der CredentialProvider.

Gibt zurück:

Nichts, wenn erfolg, andernfalls eine CompletionException

Gilt für: