SkillValidation クラス

  • リファレンス
パッケージ:
com.microsoft.bot.connector.authentication
Maven 成果物:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.connector.authentication.SkillValidation

public final class SkillValidation

スキルとの間で送受信される JWT トークンを検証します。

メソッドの概要

修飾子と型 メソッドと説明
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateChannelToken(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, AuthenticationConfiguration authConfig)

受信認証ヘッダーが、ボットからスキルまたはスキルからボットに送信されるトークンであることを検証します。
static ClaimsIdentity createAnonymousSkillClaim()

匿名 (認証されていない) スキルのクレームID を作成します。
static java.lang.Boolean isSkillClaim(Map<String,String> claims)

指定されたクレームの一覧がスキルを表しているかどうかを確認します。
static boolean isSkillToken(String authHeader)

特定の Auth ヘッダーがスキルからボット、またはボットからスキル要求のどちらに由来するかを判断します。
static java.util.concurrent.CompletableFuture<java.lang.Void> validateIdentity(ClaimsIdentity identity, CredentialProvider credentials)

スキル要求ID を検証するヘルパー。

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

メソッドの詳細

authenticateChannelToken

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

受信認証ヘッダーが、ボットからスキルまたはスキルからボットに送信されるトークンであることを検証します。

パラメーター:

authHeader - 形式の生の HTTP ヘッダー: "Bearer [longString]"。
credentials - AppId など、有効な資格情報のユーザー定義セット。
channelProvider - パブリック Azure と米国政府機関向け Azure を区別する channelService 値。
channelId - 検証するチャネルの ID。
authConfig - 認証構成。

戻り値:

検証が成功した場合の ClaimsIdentity インスタンス。

createAnonymousSkillClaim

public static ClaimsIdentity createAnonymousSkillClaim()

匿名 (認証されていない) スキルの ClaimsIdentity を作成します。

戻り値:

認証の種類が AuthenticationConstants.AnonymousAuthType に設定され、予約済みの AuthenticationConstants.AnonymousSkillAppId 要求を持つ ClaimsIdentity インスタンス。

isSkillClaim

public static Boolean isSkillClaim(Map claims)

指定されたクレームの一覧がスキルを表しているかどうかを確認します。 スキル要求には、VERSION_CLAIM 要求が含まれている必要があります。 AuthenticationConstants.AUTIENCE_CLAIM 要求。 APPID_CLAIM 要求 (v1) または AUTHORIZED_PARTY 要求 (v2)。 また、appId 要求は、対象ユーザーの要求とは異なる必要があります。 チャネル (Web チャット、チームなど) がボットを呼び出すと、AuthenticationConstants.AUTIENCE_CLAIM は TO_BOT_FROM_CHANNEL_TOKEN_ISSUER に設定されますが、ボットが別のボットを呼び出すと、対象ユーザー要求は呼び出されるボットの appId に設定されます。 このプロトコルでは、v1 トークンと v2 トークンがサポートされています。v1 トークンの場合、APPID_CLAIM が存在し、呼び出し元ボットのアプリ ID に設定されます。 v2 トークンの場合、AUTHORIZED_PARTY が存在し、呼び出し元ボットのアプリ ID に設定されます。

パラメーター:

claims - 要求の一覧。

戻り値:

要求の一覧がスキル要求の場合は true、そうでない場合は false。

isSkillToken

public static boolean isSkillToken(String authHeader)

特定の Auth ヘッダーがスキルからボット、またはボットからスキル要求のどちらに由来するかを判断します。

パラメーター:

authHeader - ベアラー トークン。"Bearer [Long String]" 形式。

戻り値:

True の 場合は、トークンがボット通信に対するスキルに対して発行されました。 それ以外の場合は false。

validateIdentity

public static CompletableFuture validateIdentity(ClaimsIdentity identity, CredentialProvider credentials)

スキル ClaimsIdentity を検証するためのヘルパー。

パラメーター:

identity - 検証する ClaimsIdentity。
credentials - CredentialProvider。

戻り値:

成功した場合は何も行われません。それ以外の場合は CompletionException

適用対象