JwtTokenValidation 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.JwtTokenValidation

public final class JwtTokenValidation

Enthält Hilfsmethoden für die Authentifizierung eingehender HTTP-Anforderungen.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider)

Authentifiziert die Anforderung und fügt die Activity#getServiceUrl() der Aktivität zum Satz vertrauenswürdiger URLs hinzu.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, AuthenticationConfiguration authConfig)

Authentifiziert die Anforderung und fügt die Activity#getServiceUrl() der Aktivität zum Satz vertrauenswürdiger URLs hinzu.
static java.lang.String getAppIdFromClaims(Map<String,String> claims)

Ruft die App--ID aus Ansprüchen ab.
static boolean isValidTokenFormat(String authHeader)

Interne Hilfsprogramm, um zu überprüfen, ob das Token die Form hat, die wir erwarten "Bearer [big long string]".
static java.util.concurrent.CompletableFuture<ClaimsIdentity> validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl)

Überprüft den Authentifizierungsheader einer eingehenden Anforderung.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl, AuthenticationConfiguration authConfig)

Überprüft den Authentifizierungsheader einer eingehenden Anforderung.

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

authenticateRequest

public static CompletableFuture authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider)

Authentifiziert die Anforderung und fügt die Activity#getServiceUrl() der Aktivität zum Satz vertrauenswürdiger URLs hinzu.

Parameter:

activity - Die eingehende Aktivität aus dem Bot Framework oder dem Emulator
authHeader - Das Bearertoken, das als Teil der Anforderung enthalten ist
credentials - Der Anmeldeinformationsanbieter des Bots.
channelProvider - Der Kanaldienstanbieter des Bots.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

authenticateRequest

public static CompletableFuture authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, AuthenticationConfiguration authConfig)

Authentifiziert die Anforderung und fügt die Activity#getServiceUrl() der Aktivität zum Satz vertrauenswürdiger URLs hinzu.

Parameter:

activity - Die eingehende Aktivität aus dem Bot Framework oder dem Emulator
authHeader - Das Bearertoken, das als Teil der Anforderung enthalten ist
credentials - Der Anmeldeinformationsanbieter des Bots.
channelProvider - Der Kanaldienstanbieter des Bots.
authConfig - Die optionale Authentifizierungskonfiguration.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

getAppIdFromClaims

public static String getAppIdFromClaims(Map claims)

Ruft die AppId aus Ansprüchen ab.

In v1-Token befindet sich die AppId im AppIdClaim-Anspruch. In v2-Token befindet sich die AppId im Anspruch "AuthorizedParty".

Parameter:

claims - Die Zuordnung von Ansprüchen.

Gibt zurück:

Der Wert des appId-Anspruchs, wenn er gefunden wird (null, wenn er keinen geeigneten Anspruch finden kann).

Löst aus:

java.lang.IllegalArgumentException - Fehlende Ansprüche

isValidTokenFormat

public static boolean isValidTokenFormat(String authHeader)

Interne Hilfsprogramm, um zu überprüfen, ob das Token die Form hat, die wir erwarten "Bearer [big long string]".

Parameter:

authHeader - Eine Zeichenfolge, die den Tokenheader enthält.

Gibt zurück:

True, wenn das Token gültig ist, "false", wenn dies nicht der Fall ist.

validateAuthHeader

public static CompletableFuture validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl)

Überprüft den Authentifizierungsheader einer eingehenden Anforderung.

Parameter:

authHeader - Der zu überprüfende Authentifizierungsheader.
credentials - Der Anmeldeinformationsanbieter des Bots.
channelProvider - Der Kanaldienstanbieter des Bots.
channelId - Die ID des Kanals, der die Anforderung gesendet hat.
serviceUrl - Die Dienst-URL für die Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. 
     On Call:

validateAuthHeader

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

Überprüft den Authentifizierungsheader einer eingehenden Anforderung.

Parameter:

authHeader - Der zu überprüfende Authentifizierungsheader.
credentials - Der Anmeldeinformationsanbieter des Bots.
channelProvider - Der Kanaldienstanbieter des Bots.
channelId - Die ID des Kanals, der die Anforderung gesendet hat.
serviceUrl - Die Dienst-URL für die Aktivität.
authConfig - Die Authentifizierungskonfiguration.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: