ホーム › System.RemoteDesktop › ITSGAuthenticationEngine

ITSGAuthenticationEngine

COM

IID9ee3e5bf-04ab-4691-998c-d7f622321a56継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

リモートデスクトップゲートウェイ (RD Gateway) のユーザーを認証するメソッドを公開します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT AuthenticateUser(GUID mainSessionId, BYTE* cookieData, DWORD numCookieBytes, UINT_PTR context, ITSGAuthenticateUserSink* pSink)

ユーザーを認証します。

mainSessionId	GUID	in	RD Gateway によって接続要求に割り当てられる一意の識別子です。
cookieData	BYTE*	in	ユーザーによって提供されたクッキーを含む BYTE へのポインターです。
numCookieBytes	DWORD	in	cookieData パラメーターによって参照されるバイト数です。
context	UINT_PTR	in	この接続に固有の値を含む ULONG へのポインターです。この値は、ITSGAuthenticateUserSink インターフェイスのメソッドを使用して RD Gateway に返す必要があります。
pSink	ITSGAuthenticateUserSink*	in	認証プラグインが認証結果を RD Gateway に通知するために使用する必要がある ITSGAuthenticateUserSink インターフェイスへのポインターです。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドが S_OK を返す場合、RD Gateway は認証プラグインが ITSGAuthenticateUserSink インターフェイスのメソッドを呼び出すのを待機します。それ以外の値が返された場合、RD Gateway は直ちに接続要求を拒否します。

AuthenticateUser メソッドを使用するサンプルについては、Remote Desktop Gateway Pluggable Authentication and Authorization サンプルを参照してください。

vtbl 4 HRESULT CancelAuthentication(GUID mainSessionId, UINT_PTR context)

既存の認証要求をキャンセルします。

mainSessionId	GUID	in	接続要求に割り当てられた識別子です。
context	UINT_PTR	in	この接続を識別する値を含む ULONG へのポインターです。この値は、ITSGAuthenticateUserSink インターフェイスのメソッドを使用して RD Gateway に返す必要があります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITSGAuthenticationEngine "{9EE3E5BF-04AB-4691-998C-D7F622321A56}"
#usecom global ITSGAuthenticationEngine IID_ITSGAuthenticationEngine "{}"
#comfunc global ITSGAuthenticationEngine_AuthenticateUser      3 int,var,int,sptr,sptr
#comfunc global ITSGAuthenticationEngine_CancelAuthentication  4 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITSGAuthenticationEngine "{9EE3E5BF-04AB-4691-998C-D7F622321A56}"
#usecom global ITSGAuthenticationEngine IID_ITSGAuthenticationEngine "{}"
#comfunc global ITSGAuthenticationEngine_AuthenticateUser      3 int,sptr,int,sptr,sptr
#comfunc global ITSGAuthenticationEngine_CancelAuthentication  4 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。