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

IX509CertificateRequestPkcs10V2

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

公式ドキュメント

IX509CertificateRequestPkcs10V2 インターフェイスは、PKCS を表します

メソッド 5

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

vtbl 60 HRESULT InitializeFromTemplate(X509CertificateEnrollmentContext context, IX509EnrollmentPolicyServer* pPolicyServer, IX509CertificateTemplate* pTemplate)

テンプレートを使用して証明書要求を初期化します。(IX509CertificateRequestPkcs10V2.InitializeFromTemplate)

contextX509CertificateEnrollmentContextin

要求される証明書がエンドユーザー、コンピューター、またはコンピューターの代理として動作する管理者のいずれを対象とするかを指定する X509CertificateEnrollmentContext 列挙値です。次のいずれかの値を指定できます。

意味
ContextUser
エンドユーザーのために証明書が要求されています。
ContextMachine
コンピューターのために証明書が要求されています。
ContextAdministratorForceMachine
コンピューターの代理として動作する管理者によって証明書が要求されています。
pPolicyServerIX509EnrollmentPolicyServer*inoptionalpTemplate パラメーターで指定されたテンプレートを含む証明書登録 (エンロール) ポリシー (CEP) サーバーを表す IX509EnrollmentPolicyServer オブジェクトへのポインターです。
pTemplateIX509CertificateTemplate*inoptional初期化時に使用するテンプレートを表す IX509CertificateTemplate オブジェクトへのポインターです。

戻り値

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

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

戻り値のコード 説明
E_POINTER
pPolicyServer または pTemplate パラメーターが NULL です。
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
証明書要求オブジェクトは既に初期化されています。

解説(Remarks)

InitializeFromTemplate メソッドは、次のコレクションを作成します。

続いてメソッドはテンプレートを調べ、次の処理を実行します。

CSPInformations プロパティが NULL の場合、メソッドはコンピューターにインストールされているプロバイダーから ICspInformations コレクションを作成します。

vtbl 61 HRESULT InitializeFromPrivateKeyTemplate(X509CertificateEnrollmentContext Context, IX509PrivateKey* pPrivateKey, IX509EnrollmentPolicyServer* pPolicyServer, IX509CertificateTemplate* pTemplate)

IX509PrivateKey オブジェクトと証明書テンプレートを使用して証明書要求を初期化します。(IX509CertificateRequestPkcs10V2.InitializeFromPrivateKeyTemplate)

ContextX509CertificateEnrollmentContextin

要求される証明書がエンドユーザー、コンピューター、またはコンピューターの代理として動作する管理者のいずれを対象とするかを指定する X509CertificateEnrollmentContext 列挙値です。次のいずれかの値を指定できます。ただし、秘密キーMachineContext プロパティが設定されている場合は、ContextMachine 列挙値を指定する必要があります。

意味
ContextUser
エンドユーザーのために証明書が要求されています。
ContextMachine
コンピューターのために証明書が要求されています。
ContextAdministratorForceMachine
コンピューターの代理として動作する管理者によって証明書が要求されています。
pPrivateKeyIX509PrivateKey*inoptional秘密キーを表す IX509PrivateKey インターフェイスへのポインターです。
pPolicyServerIX509EnrollmentPolicyServer*inoptionalpTemplate パラメーターで指定されたテンプレートを含む証明書登録 (エンロール) ポリシー (CEP) サーバーを表す IX509EnrollmentPolicyServer オブジェクトへのポインターです。
pTemplateIX509CertificateTemplate*inoptional初期化時に使用するテンプレートを表す IX509CertificateTemplate オブジェクトへのポインターです。

戻り値

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

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

戻り値のコード 説明
E_POINTER
pPrivateKeypPolicyServer、または pTemplate パラメーターが NULL です。
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
証明書要求オブジェクトは既に初期化されています。

解説(Remarks)

InitializeFromPrivateKeyTemplate メソッドは、次の処理を実行します。

CSPInformations プロパティが指定されていない場合、メソッドはコンピューターにインストールされているプロバイダーから ICspInformations コレクションを作成します。

この時点では秘密キーは作成されません。メソッドに渡された IX509PrivateKey オブジェクトが既存のキーを表していない場合、Encode メソッドが呼び出されたときにキーが作成されます。テンプレートが指定されておらず、IX509PrivateKeyProviderName プロパティが設定されていない場合、キーは既定のプロバイダーを使用して作成されます。秘密キーが存在する場合、それは PrivateKey プロパティに設定されます。

vtbl 62 HRESULT InitializeFromPublicKeyTemplate(X509CertificateEnrollmentContext Context, IX509PublicKey* pPublicKey, IX509EnrollmentPolicyServer* pPolicyServer, IX509CertificateTemplate* pTemplate)

IX509PublicKey オブジェクトとテンプレートを使用して、null 署名された証明書要求を初期化します。

ContextX509CertificateEnrollmentContextin

要求される証明書がエンドユーザー、コンピューター、またはコンピューターの代理として動作する管理者のいずれを対象とするかを指定する X509CertificateEnrollmentContext 列挙値です。次のいずれかの値を指定できます。

意味
ContextUser
エンドユーザーのために証明書が要求されています。
ContextMachine
コンピューターのために証明書が要求されています。
ContextAdministratorForceMachine
コンピューターの代理として動作する管理者によって証明書が要求されています。
pPublicKeyIX509PublicKey*inoptional公開キーを表す IX509PublicKey インターフェイスへのポインターです。
pPolicyServerIX509EnrollmentPolicyServer*inoptionalpTemplate パラメーターで指定されたテンプレートを含む証明書登録 (エンロール) ポリシー (CEP) サーバーを表す IX509EnrollmentPolicyServer オブジェクトへのポインターです。
pTemplateIX509CertificateTemplate*inoptional初期化時に使用するテンプレートを表す IX509CertificateTemplate オブジェクトへのポインターです。

戻り値

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

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

戻り値のコード/値 説明
E_POINTER
pPublicKeypPolicyServer、または pTemplate パラメーターが NULL です。
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
証明書要求オブジェクトは既に初期化されています。

解説(Remarks)

InitializeFromPublicKeyTemplate メソッドは、次の処理を実行します。

CSPInformations プロパティが指定されていない場合、メソッドはコンピューターにインストールされているプロバイダーから ICspInformations コレクションを作成します。

このメソッドは秘密キーを作成しません。このメソッドを使用することは、要求が null 署名であることを意味します。したがって、メソッドは IX509SignatureInformation オブジェクトの NullSigned プロパティを設定します。

vtbl 63 HRESULT get_PolicyServer(IX509EnrollmentPolicyServer** ppPolicyServer)

初期化時に使用されたテンプレートを含む証明書登録 (エンロール) ポリシー (CEP) サーバーを取得します。(IX509CertificateRequestPkcs10V2.get_PolicyServer)

ppPolicyServerIX509EnrollmentPolicyServer**out要求に関連付けられた IX509EnrollmentPolicyServer オブジェクトを受け取るポインタである。
vtbl 64 HRESULT get_Template(IX509CertificateTemplate** ppTemplate)

初期化時に使用された証明書要求テンプレートを取得します。(IX509CertificateRequestPkcs10V2.get_Template)

ppTemplateIX509CertificateTemplate**out要求に関連付けられた IX509CertificateTemplate オブジェクトを受け取るポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IX509CertificateRequestPkcs10V2 "{728AB35B-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX509CertificateRequestPkcs10V2 IID_IX509CertificateRequestPkcs10V2 "{}"
#comfunc global IX509CertificateRequestPkcs10V2_InitializeFromTemplate            60 int,sptr,sptr
#comfunc global IX509CertificateRequestPkcs10V2_InitializeFromPrivateKeyTemplate  61 int,sptr,sptr,sptr
#comfunc global IX509CertificateRequestPkcs10V2_InitializeFromPublicKeyTemplate   62 int,sptr,sptr,sptr
#comfunc global IX509CertificateRequestPkcs10V2_get_PolicyServer                  63 sptr
#comfunc global IX509CertificateRequestPkcs10V2_get_Template                      64 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。