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

ICertPropertyRenewal

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

公式ドキュメント

既存の証明書が更新されたときに作成される新しい証明書の SHA-1 ハッシュを格納する証明書プロパティを表します。

メソッド 3

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

vtbl 14 HRESULT Initialize(EncodingType Encoding, LPWSTR strRenewalValue)

新しい証明書の SHA-1 ハッシュからオブジェクトを初期化します。

EncodingEncodingTypeinハッシュを格納する入力文字列に適用される Unicode エンコードの種類を指定する EncodingType 列挙値です。
strRenewalValueLPWSTRinハッシュを格納する BSTR 変数です。

戻り値

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

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

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

解説(Remarks)

通常、このプロパティは登録(エンロール)プロセス中に初期化されます。登録中に使用された証明書は、IX509Enrollment インターフェイスの Certificate プロパティを呼び出すことで取得できます。

プロパティを証明書に関連付けるには、SetValueOnCertificate メソッドを呼び出します。ハッシュを取得するには、Renewal プロパティを呼び出します。

vtbl 15 HRESULT InitializeFromCertificateHash(VARIANT_BOOL MachineContext, EncodingType Encoding, LPWSTR strCertificate)

新しい証明書からオブジェクトを初期化します。

MachineContextVARIANT_BOOLin証明書ストアがローカルコンピューター用か現在のユーザー用かを示す VARIANT_BOOL 値です。コンピューターの場合は VARIANT_TRUE を、ユーザーの場合は VARIANT_FALSE を指定します。
EncodingEncodingTypeinDER エンコードされた証明書を格納する入力文字列に適用される 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 を参照してください。

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

解説(Remarks)

このメソッドは、指定された証明書を使用して SHA-1 ハッシュを作成します。証明書は、Abstract Syntax Notation One(ASN.1)標準で定義されている Distinguished Encoding Rules(DER)を使用してエンコードされている必要があります。また、DER エンコードされた証明書を格納する文字列に適用される Unicode エンコードの種類も指定する必要があります。

通常、ICertPropertyRenewal オブジェクトは登録(エンロール)プロセス中に初期化されます。登録中に使用された証明書は、IX509Enrollment インターフェイスの Certificate プロパティを呼び出すことで取得できます。

プロパティを証明書に関連付けるには、SetValueOnCertificate メソッドを呼び出します。ハッシュを取得するには、Renewal プロパティを呼び出します。

vtbl 16 HRESULT get_Renewal(EncodingType Encoding, LPWSTR* pValue)

新しい証明書の SHA-1 ハッシュを取得します。

EncodingEncodingTypein出力する pValue の希望するエンコード形式を指定する EncodingType 値である。
pValueLPWSTR*out更新プロパティの値 (更新元証明書のハッシュ) を指定エンコード形式で受け取る出力先である。

解説(Remarks)

Renewal プロパティの値を指定するには、Initialize メソッドまたは InitializeFromCertificateHash メソッドを呼び出します。

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