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

ICertProperty

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

公式ドキュメント

外部プロパティを証明書に関連付けるために使用できます。

メソッド 7

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

vtbl 7 HRESULT InitializeFromCertificate(VARIANT_BOOL MachineContext, EncodingType Encoding, LPWSTR strCertificate)

既存の証明書に関連付けられたプロパティ値を使用してオブジェクトを初期化します。

MachineContextVARIANT_BOOLin証明書ストアがローカルコンピューター用か現在のユーザー用かを示す VARIANT_BOOL 値です。コンピューターの場合は VARIANT_TRUE、ユーザーの場合は VARIANT_FALSE を指定します。
EncodingEncodingTypeinstrCertificate パラメーターに格納された証明書に適用される Unicode エンコードの種類を指定する EncodingType 列挙値です。
strCertificateLPWSTRin

DER エンコードされた証明書を格納する BSTR 変数です。

Windows 7 および Windows Server 2008 R2 以降では、エンコードされた証明書の代わりに証明書のサムプリントまたはシリアル番号を指定できます。指定すると、この関数は一致する証明書を該当するローカルストアから検索します。次の点に注意してください。

  • BSTR は偶数個の 16 進数字である必要があります。
  • 16 進ペア間の空白は無視されます。
  • Encoding パラメーターは XCN_CRYPT_STRING_HEXRAW に設定する必要があります。
  • MachineContext パラメーターにより、ユーザーストアとコンピューターストアのどちらか、または両方が検索されるかが決まります。
  • 秘密キーが必要な場合は、個人ストアと要求ストアのみが検索されます。
  • 秘密キーが不要な場合は、ルートストアと中間 CA ストアも検索されます。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値/値 説明
CRYPT_E_NOT_FOUND
 証明書が見つかりませんでした。
CRYPT_E_UNEXPECTED_MSG_TYPE
 証明書は見つかりましたが、秘密キーを読み込めませんでした。

解説(Remarks)

初期化するプロパティは、PropertyId プロパティを呼び出して指定します。RawData プロパティを呼び出すと、プロパティを格納したエンコード済み文字列を取得できます。

vtbl 8 HRESULT InitializeDecode(EncodingType Encoding, LPWSTR strEncodedData)

プロパティ値を格納したバイト配列からオブジェクトを初期化します。

EncodingEncodingTypein入力文字列に適用される Unicode エンコードの種類を指定する EncodingType 列挙値です。
strEncodedDataLPWSTRinDistinguished Encoding Rules (DER) でエンコードされたプロパティ値を格納する BSTR 変数です。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値/値 説明
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
 オブジェクトは既に初期化されています。

解説(Remarks)

初期化するプロパティは、PropertyId プロパティを呼び出して指定します。RawData プロパティを呼び出すと、エンコードされたプロパティ値を取得できます。SetValueOnCertificate メソッドを呼び出して、プロパティ値を証明書に関連付けます。

InitializeDecode メソッドが失敗した場合、ICertProperty オブジェクトは初期化されず、入力されたプロパティ値も保存されません。ただし、PropertyId プロパティには、指定した識別子が保持されます。

InitializeDecode メソッドは、カスタムプロパティや、専用のインターフェイスが存在せず CERTENROLL_PROPERTYID 列挙で識別されるプロパティを初期化できるようにするために用意されています。この列挙でサポートされる各値には、InitializeDecode メソッドに指定する必要があるデータの種類 (通常は CRYPT_INTEGER_BLOB) に関する情報が含まれます。IBinaryConverter インターフェイスを使用すると、バイト配列を文字列に変換できます。

次のインターフェイスは、最も一般的なプロパティの作成を簡素化します。

vtbl 9 HRESULT get_PropertyId(CERTENROLL_PROPERTYID* pValue)

外部証明書プロパティを識別する CERTENROLL_PROPERTYID 列挙の値を指定または取得します。(Get)

pValueCERTENROLL_PROPERTYID*out証明書プロパティの識別子を示す CERTENROLL_PROPERTYID 値を受け取る出力先である。

解説(Remarks)

ICertProperty オブジェクトの初期化を試みる前に、PropertyId プロパティを呼び出します。InitializeDecode メソッドまたは InitializeFromCertificate メソッドを呼び出して、証明書プロパティの値を作成します。RawData プロパティを呼び出して、プロパティ値を取得します。

vtbl 10 HRESULT put_PropertyId(CERTENROLL_PROPERTYID Value)

外部証明書プロパティを識別する CERTENROLL_PROPERTYID 列挙の値を指定または取得します。(Put)

ValueCERTENROLL_PROPERTYIDin設定する証明書プロパティの識別子を示す CERTENROLL_PROPERTYID 値である。

解説(Remarks)

ICertProperty オブジェクトの初期化を試みる前に、PropertyId プロパティを呼び出します。InitializeDecode メソッドまたは InitializeFromCertificate メソッドを呼び出して、証明書プロパティの値を作成します。RawData プロパティを呼び出して、プロパティ値を取得します。

vtbl 11 HRESULT get_RawData(EncodingType Encoding, LPWSTR* pValue)

証明書プロパティの値を取得します。

EncodingEncodingTypein出力する pValue の希望するエンコード形式を指定する EncodingType 値である。
pValueLPWSTR*out証明書プロパティの生データ (RAW) を指定エンコード形式で受け取る出力先である。

解説(Remarks)

RawData プロパティを呼び出す前に、PropertyId を呼び出して、取得するプロパティを指定します。

vtbl 12 HRESULT RemoveFromCertificate(VARIANT_BOOL MachineContext, EncodingType Encoding, LPWSTR strCertificate)

プロパティと証明書の関連付けを解除します。

MachineContextVARIANT_BOOLin証明書ストアがローカルコンピューター上にあるかどうかを示す VARIANT_BOOL 値です。ストアがローカルにある場合は VARIANT_TRUE を指定します。
EncodingEncodingTypeinstrCertificate パラメーターで識別される証明書文字列に適用されるエンコードの種類を指定する EncodingType 列挙値です。
strCertificateLPWSTRin

DER エンコードされた証明書を格納する BSTR 変数です。

Windows 7 および Windows Server 2008 R2 以降では、エンコードされた証明書の代わりに証明書のサムプリントまたはシリアル番号を指定できます。指定すると、この関数は一致する証明書を該当するローカルストアから検索します。次の点に注意してください。

  • BSTR は偶数個の 16 進数字である必要があります。
  • 16 進ペア間の空白は無視されます。
  • Encoding パラメーターは XCN_CRYPT_STRING_HEXRAW に設定する必要があります。
  • MachineContext パラメーターにより、ユーザーストアとコンピューターストアのどちらか、または両方が検索されるかが決まります。
  • 秘密キーが必要な場合は、個人ストアと要求ストアのみが検索されます。
  • 秘密キーが不要な場合は、ルートストアと中間 CA ストアも検索されます。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値/値 説明
CRYPT_E_NOT_FOUND
 証明書が見つかりませんでした。
CRYPT_E_UNEXPECTED_MSG_TYPE
 証明書は見つかりましたが、秘密キーを読み込めませんでした。
vtbl 13 HRESULT SetValueOnCertificate(VARIANT_BOOL MachineContext, EncodingType Encoding, LPWSTR strCertificate)

プロパティ値を既存の証明書に関連付けます。

MachineContextVARIANT_BOOLin証明書ストアがローカルコンピューター用か現在のユーザー用かを示す VARIANT_BOOL 値です。コンピューターの場合は VARIANT_TRUE、ユーザーの場合は VARIANT_FALSE を指定します。
EncodingEncodingTypeinstrCertificate パラメーターで識別される証明書文字列に適用される Unicode エンコードの種類を指定する EncodingType 列挙値です。
strCertificateLPWSTRin

DER エンコードされた証明書を格納する BSTR 変数です。

Windows 7 および Windows Server 2008 R2 以降では、エンコードされた証明書の代わりに証明書のサムプリントまたはシリアル番号を指定できます。指定すると、この関数は一致する証明書を該当するローカルストアから検索します。次の点に注意してください。

  • BSTR は偶数個の 16 進数字である必要があります。
  • 16 進ペア間の空白は無視されます。
  • Encoding パラメーターは XCN_CRYPT_STRING_HEXRAW に設定する必要があります。
  • MachineContext パラメーターにより、ユーザーストアとコンピューターストアのどちらか、または両方が検索されるかが決まります。
  • 秘密キーが必要な場合は、個人ストアと要求ストアのみが検索されます。
  • 秘密キーが不要な場合は、ルートストアと中間 CA ストアも検索されます。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値/値 説明
CRYPT_E_NOT_FOUND
 証明書が見つかりませんでした。
CRYPT_E_UNEXPECTED_MSG_TYPE
 証明書は見つかりましたが、秘密キーを読み込めませんでした。

解説(Remarks)

InitializeDecode メソッドまたは InitializeFromCertificate メソッドを呼び出して、プロパティ値を作成します。いずれのメソッドを呼び出す前にも、まず PropertyId プロパティを設定して、初期化するプロパティ値を指定する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICertProperty "{728AB32E-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global ICertProperty IID_ICertProperty "{}"
#comfunc global ICertProperty_InitializeFromCertificate  7 int,int,wstr
#comfunc global ICertProperty_InitializeDecode           8 int,wstr
#comfunc global ICertProperty_get_PropertyId             9 var
#comfunc global ICertProperty_put_PropertyId             10 int
#comfunc global ICertProperty_get_RawData                11 int,var
#comfunc global ICertProperty_RemoveFromCertificate      12 int,int,wstr
#comfunc global ICertProperty_SetValueOnCertificate      13 int,int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。