Win32 API 日本語リファレンス
ホームSecurity.Tpm › ITpmVirtualSmartCardManager

ITpmVirtualSmartCardManager

COM
IID112b1dff-d9dc-41f7-869f-d67fee7cb591継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

TPM 仮想スマートカードを管理します。

メソッド 2

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

vtbl 3 HRESULT CreateVirtualSmartCard(LPWSTR pszFriendlyName, BYTE bAdminAlgId, BYTE* pbAdminKey, DWORD cbAdminKey, BYTE* pbAdminKcv, DWORD cbAdminKcv, BYTE* pbPuk, DWORD cbPuk, BYTE* pbPin, DWORD cbPin, BOOL fGenerate, ITpmVirtualSmartCardManagerStatusCallback* pStatusCallback, LPWSTR* ppszInstanceId, BOOL* pfNeedReboot)

指定されたパラメーターで TPM 仮想スマートカードを作成します。

pszFriendlyNameLPWSTRinスマートカードリーダーノードの表示名です。これはデバイスマネージャーに表示されますが、スマートカードリソースマネージャー (SCRM) から見えるリーダー名ではありません。
bAdminAlgIdBYTEin管理者キーのアルゴリズム識別子です。現在、インボックスの GIDS ミニドライバーで動作させるには、この値を VSC_DEFAULT_ADMIN_ALGORITHM_ID (CBC 連鎖モードで ISO/IEC 9797 パディング方法 2 を使用する 3 キーのトリプル DES) にする必要があります。
pbAdminKeyBYTE*in作成する仮想スマートカードの管理者キーを格納するバイト配列へのポインターです。
cbAdminKeyDWORDinpbAdminKey パラメーターが指すバイト配列のサイズ (バイト単位) です。
pbAdminKcvBYTE*in管理者キーのキーチェック値を格納するバイト配列へのポインターです。キーチェック値は、管理者キーを使用してゼロのブロックを暗号化したときの出力 BLOB の先頭 3 バイトとして定義されます。キーチェック値を指定しない場合、管理者キーの整合性チェックは行われません。
cbAdminKcvDWORDinpbAdminKcv パラメーターが指すバイト配列のサイズ (バイト単位) です。
pbPukBYTE*in仮想スマートカードの PIN ロック解除キー (PUK) 値を格納するバイト配列へのポインターです。通常は最小 8 文字の ASCII 文字列です。PUK を指定しない場合、仮想スマートカードは PUK ロールなしで作成され、代わりに管理者ロールを介したチャレンジ/レスポンス方式の PIN リセットが使用されます。
cbPukDWORDinpbPuk パラメーターが指すバイト配列のサイズ (バイト単位) です。
pbPinBYTE*in仮想スマートカードの PIN 値を格納するバイト配列へのポインターです。通常は最小 8 文字、最大 127 文字の ASCII 文字列です。
cbPinDWORDinpbPin パラメーターが指すバイト配列のサイズ (バイト単位) です。
fGenerateBOOLin基本 CSP およびスマートカード KSP が必要とするすべてのファイルを仮想スマートカードにプロビジョニングする必要があるかどうかを示します。
pStatusCallbackITpmVirtualSmartCardManagerStatusCallback*inITpmVirtualSmartCardManagerStatusCallback インターフェイスへのポインターです。TPM 仮想スマートカードマネージャーは、このコールバックインターフェイスを使用して、仮想スマートカードの作成中の進行状況やエラーを通知します。pStatusCallback パラメーターが NULL の場合、操作が完了するまでクライアントに進行状況は報告されません。
ppszInstanceIdLPWSTR*out作成された仮想スマートカードのインスタンス ID を受け取る Unicode バッファーへのポインターへのポインターです。
pfNeedRebootBOOL*out要求された操作でコンピューターの再起動が必要かどうかを受け取るブール値へのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合は Win32 エラーコードを返します。

解説(Remarks)

メソッドが成功すると、ppszInstanceId パラメーターは、新しく作成された TPM 仮想スマートカードリーダーのインスタンス識別子を格納する Unicode バッファーを指します。バッファーの使用を終えたら、COM のメモリ管理規則に従い、呼び出し元がクライアント側で CoTaskMemFree 関数を呼び出してバッファーを解放する必要があります。

vtbl 4 HRESULT DestroyVirtualSmartCard(LPWSTR pszInstanceId, ITpmVirtualSmartCardManagerStatusCallback* pStatusCallback, BOOL* pfNeedReboot)

指定されたインスタンス ID を持つ TPM 仮想スマートカードを破棄します。

pszInstanceIdLPWSTRinCreateVirtualSmartCard メソッドの呼び出しが成功したときに返される、TPM 仮想スマートカードのインスタンス識別子です。
pStatusCallbackITpmVirtualSmartCardManagerStatusCallback*inITpmVirtualSmartCardManagerStatusCallback インターフェイスへのポインターです。TPM 仮想スマートカードマネージャーは、このコールバックインターフェイスを使用して、仮想スマートカードの作成中の進行状況やエラーを通知します。pStatusCallback パラメーターが NULL の場合、操作が完了するまでクライアントに進行状況は報告されません。
pfNeedRebootBOOL*out要求された操作でクライアントコンピューターの再起動が必要かどうかを受け取るブール値へのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合は Win32 エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITpmVirtualSmartCardManager "{112B1DFF-D9DC-41F7-869F-D67FEE7CB591}"
#usecom global ITpmVirtualSmartCardManager IID_ITpmVirtualSmartCardManager "{16A18E86-7F6E-4C20-AD89-4FFC0DB7A96A}"
#comfunc global ITpmVirtualSmartCardManager_CreateVirtualSmartCard   3 wstr,int,var,int,var,int,var,int,var,int,int,sptr,var,var
#comfunc global ITpmVirtualSmartCardManager_DestroyVirtualSmartCard  4 wstr,sptr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。