Win32 API 日本語リファレンス
ホーム › Security.Cryptography.Certificates › IX509EndorsementKey

IX509EndorsementKey

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDb11cd855-f4c4-4fc6-b710-4422237f09e9継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

X.509 エンドースメントキーインターフェイス

メソッド 11

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_ProviderName(LPWSTR* pValue)

暗号化プロバイダーの名前。既定は Microsoft Platform Crypto Provider です。ProviderName プロパティは Open メソッドを呼び出す前に設定する必要があります。Open メソッドを呼び出した後は ProviderName プロパティを変更できません。(Get)

pValueLPWSTR*out使用するプロバイダー名を受け取る文字列ポインタである。
vtbl 8 HRESULT put_ProviderName(LPWSTR Value)

暗号化プロバイダーの名前。既定は Microsoft Platform Crypto Provider です。ProviderName プロパティは Open メソッドを呼び出す前に設定する必要があります。Open メソッドを呼び出した後は ProviderName プロパティを変更できません。(Put)

ValueLPWSTRin設定するプロバイダー名を指定する。
vtbl 9 HRESULT get_Length(INT* pValue)

エンドースメントキーのビット長。このプロパティには Open メソッドを呼び出した後にのみアクセスできます。

pValueINT*out保証鍵 (EK) の鍵長 (ビット数) を受け取る INT へのポインタである。
vtbl 10 HRESULT get_Opened(VARIANT_BOOL* pValue)

Open メソッドが正常に呼び出されたかどうかを示します。

pValueVARIANT_BOOL*out鍵が開かれているかどうかを受け取る VARIANT_BOOL へのポインタである。
vtbl 11 HRESULT AddCertificate(EncodingType Encoding, LPWSTR strCertificate)

エンドースメントキーをサポートするキーストレージプロバイダー (KSP) に、エンドースメントキー証明書を追加します。

EncodingEncodingTypein証明書に適用される Unicode エンコードの種類を指定する EncodingType 列挙値。既定値は XCN_CRYPT_STRING_BASE64 です。
strCertificateLPWSTRinストアに追加する証明書。この証明書の公開キーは、エンドースメントキーの公開キーと一致している必要があります。

戻り値

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

解説(Remarks)

キーストレージプロバイダーに追加できるのは、製造元以外の証明書のみです。

vtbl 12 HRESULT RemoveCertificate(EncodingType Encoding, LPWSTR strCertificate)

エンドースメントキーに関連するエンドースメント証明書を、キーストレージプロバイダーから削除します。RemoveCertificate メソッドは、Open メソッドが正常に呼び出された後にのみ呼び出すことができます。

EncodingEncodingTypeinエンドースメント証明書に適用される Unicode エンコードの種類を指定する EncodingType 列挙値。既定値は XCN_CRYPT_STRING_BASE64 です。
strCertificateLPWSTRinストアから削除する証明書。

戻り値

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

解説(Remarks)

キーストレージプロバイダーから削除できるのは、製造元以外の証明書のみです。

vtbl 13 HRESULT GetCertificateByIndex(VARIANT_BOOL ManufacturerOnly, INT dwIndex, EncodingType Encoding, LPWSTR* pValue)

指定したインデックスについて、エンドースメントキーに関連付けられたエンドースメント証明書をキーストレージプロバイダーから取得します。

ManufacturerOnlyVARIANT_BOOLin製造元のエンドースメントキーのみを取得する場合は True、それ以外は false。既定は false です。
dwIndexINTin要求するエンドースメント証明書のインデックス。
EncodingEncodingTypeinエンドースメント証明書に適用される Unicode エンコードの種類を指定する EncodingType 列挙値。既定値は XCN_CRYPT_STRING_BASE64 です。
pValueLPWSTR*out要求されたエンドースメント証明書。

戻り値

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

vtbl 14 HRESULT GetCertificateCount(VARIANT_BOOL ManufacturerOnly, INT* pCount)

キーストレージプロバイダー内のエンドースメント証明書の数を取得します。

ManufacturerOnlyVARIANT_BOOLin製造元の証明書のみの数を返す場合は True。製造元以外の証明書のみの数を返す場合は False。
pCountINT*outキーストレージプロバイダーから取得したエンドースメント証明書の数。

戻り値

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

vtbl 15 HRESULT ExportPublicKey(IX509PublicKey** ppPublicKey)

エンドースメント公開キーをエクスポートします。

ppPublicKeyIX509PublicKey**outエクスポートされたエンドースメント公開キー。

戻り値

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

vtbl 16 HRESULT Open()

エンドースメントキーを開きます。エンドースメントキーから情報を取得する、証明書を追加または削除する、あるいはエンドースメントキーをエクスポートするには、事前にエンドースメントキーを開いておく必要があります。

戻り値

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

vtbl 17 HRESULT Close()

エンドースメントキーを閉じます。Close メソッドは、Open メソッドが正常に呼び出された後にのみ呼び出すことができます。

戻り値

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

解説(Remarks)

Close メソッドは、ProviderName を除き、オブジェクトが保持しているすべてのリソースを解放します。 ProviderName は、再割り当てされたとき、またはこのオブジェクトが破棄されたときに解放されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IX509EndorsementKey "{B11CD855-F4C4-4FC6-B710-4422237F09E9}"
#usecom global IX509EndorsementKey IID_IX509EndorsementKey "{}"
#comfunc global IX509EndorsementKey_get_ProviderName       7 var
#comfunc global IX509EndorsementKey_put_ProviderName       8 wstr
#comfunc global IX509EndorsementKey_get_Length             9 var
#comfunc global IX509EndorsementKey_get_Opened             10 var
#comfunc global IX509EndorsementKey_AddCertificate         11 int,wstr
#comfunc global IX509EndorsementKey_RemoveCertificate      12 int,wstr
#comfunc global IX509EndorsementKey_GetCertificateByIndex  13 int,int,int,var
#comfunc global IX509EndorsementKey_GetCertificateCount    14 int,var
#comfunc global IX509EndorsementKey_ExportPublicKey        15 sptr
#comfunc global IX509EndorsementKey_Open                   16
#comfunc global IX509EndorsementKey_Close                  17
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。