JwtTokenValidation クラス

  • java.lang.Object
    • com.microsoft.bot.connector.authentication.JwtTokenValidation

public final class JwtTokenValidation

受信 HTTP 要求を認証するためのヘルパー メソッドが含まれています。

メソッドの概要

修飾子と型 メソッドと説明
static

java.util.concurrent.CompletableFuture<ClaimsIdentity>

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

要求を認証し、アクティビティ Activity#getServiceUrl() の を信頼された URL のセットに追加します。

static

java.util.concurrent.CompletableFuture<ClaimsIdentity>

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

要求を認証し、アクティビティ Activity#getServiceUrl() の を信頼された URL のセットに追加します。

static java.lang.String getAppIdFromClaims(Map<String,String> claims)

要求からアプリID を取得します。

static boolean isValidTokenFormat(String authHeader)

トークンに "Bearer [big long string]" と想定される形状があるかどうかを確認する内部ヘルパー。

static

java.util.concurrent.CompletableFuture<ClaimsIdentity>

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

受信要求の認証ヘッダーを検証します。

static

java.util.concurrent.CompletableFuture<ClaimsIdentity>

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

受信要求の認証ヘッダーを検証します。

メソッドの継承元: 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

メソッドの詳細

authenticateRequest

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

要求を認証し、アクティビティ Activity#getServiceUrl() の を信頼された URL のセットに追加します。

Parameters:

activity - Bot Framework またはエミュレーターからの受信アクティビティ
authHeader - 要求の一部として含まれるベアラー トークン
credentials - ボットの資格情報プロバイダー。
channelProvider - ボットのチャネル サービス プロバイダー。

Returns:

実行するキューに登録された作業を表すタスク。

authenticateRequest

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

要求を認証し、アクティビティ Activity#getServiceUrl() の を信頼された URL のセットに追加します。

Parameters:

activity - Bot Framework またはエミュレーターからの受信アクティビティ
authHeader - 要求の一部として含まれるベアラー トークン
credentials - ボットの資格情報プロバイダー。
channelProvider - ボットのチャネル サービス プロバイダー。
authConfig - オプションの認証構成。

Returns:

実行するキューに登録された作業を表すタスク。

getAppIdFromClaims

public static String getAppIdFromClaims(Map claims)

要求から AppId を取得します。

v1 トークンでは、AppId は AppIdClaim 要求にあります。 v2 トークンでは、AppId は AuthorizedParty 要求にあります。

Parameters:

claims - 要求のマップ。

Returns:

appId 要求が見つかった場合の値 (適切な要求が見つからない場合は null)。

Throws:

java.lang.IllegalArgumentException - 要求が見つかりません

isValidTokenFormat

public static boolean isValidTokenFormat(String authHeader)

トークンに "Bearer [big long string]" と想定される形状があるかどうかを確認する内部ヘルパー。

Parameters:

authHeader - トークン ヘッダーを含む文字列。

Returns:

トークンが有効な場合は True、有効でない場合は false。

validateAuthHeader

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

受信要求の認証ヘッダーを検証します。

Parameters:

authHeader - 検証する認証ヘッダー。
credentials - ボットの資格情報プロバイダー。
channelProvider - ボットのチャネル サービス プロバイダー。
channelId - 要求を送信したチャネルの ID。
serviceUrl - アクティビティのサービス URL。

Returns:

実行するキューに登録された作業を表すタスク。
     On Call:

validateAuthHeader

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

受信要求の認証ヘッダーを検証します。

Parameters:

authHeader - 検証する認証ヘッダー。
credentials - ボットの資格情報プロバイダー。
channelProvider - ボットのチャネル サービス プロバイダー。
channelId - 要求を送信したチャネルの ID。
serviceUrl - アクティビティのサービス URL。
authConfig - 認証の構成。

Returns:

実行するキューに登録された作業を表すタスク。

適用対象