IX509CertificateRequestCertificate2
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
IX509CertificateRequestCertificate2 インターフェイスは、自己生成された証明書の要求オブジェクトを表し、登録(エンロール)や証明機関(CA)を経由せずに直接証明書を作成できるようにします。
メソッド 4
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
テンプレートを使用して証明書要求を初期化します。(IX509CertificateRequestCertificate2.InitializeFromTemplate)
| context | X509CertificateEnrollmentContext | in | 要求される証明書がエンドユーザー向けか、コンピューター向けか、またはコンピューターの代理として動作する管理者向けかを指定する X509CertificateEnrollmentContext 列挙値です。次のいずれかの値を指定できます。
| ||||||||
| pPolicyServer | IX509EnrollmentPolicyServer* | inoptional | pTemplate パラメーターで指定されたテンプレートを含む証明書登録ポリシー(CEP)サーバーを表す IX509EnrollmentPolicyServer オブジェクトへのポインターです。 | ||||||||
| pTemplate | IX509CertificateTemplate* | inoptional | 初期化中に使用するテンプレートを表す IX509CertificateTemplate オブジェクトへのポインターです。 |
戻り値
関数が成功すると、S_OK を返します。
関数が失敗すると、エラーを示す HRESULT 値を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。
| 戻り値 | 説明 |
|---|---|
| pTemplate パラメーターを NULL にすることはできません。 | |
|
証明書要求オブジェクトは既に初期化されています。 |
解説(Remarks)
InitializeFromTemplate メソッドは、次のコレクションを作成します。
- ICryptAttributes コレクション。
- IX509Extensions コレクション。
- 既定の XCN_OID_KEY_USAGE および XCN_OID_BASIC_CONSTRAINTS2 オブジェクト識別子が設定された IObjectIds コレクション。
- 新しい要求から抑制する属性および拡張の OID を格納するための、空の IObjectIds コレクション。
続いてこのメソッドはテンプレートを調べ、次の処理を実行します。
- テンプレートで指定された拡張を IX509Extensions コレクションに追加します。
- テンプレートがこれらを重要(critical)でないと示している場合、既定の重要な拡張(XCN_OID_KEY_USAGE および XCN_OID_BASIC_CONSTRAINTS2)をコレクションから削除します。テンプレートによって重要とマークされた OID は追加されます。
- テンプレートが対称アルゴリズムをサポートしている場合、SmimeCapabilities プロパティを設定します。
- テンプレートが個別の署名アルゴリズム OID を必要とする場合、AlternateSignatureAlgorithm プロパティを設定します。
- IX509SignatureInformation オブジェクトを作成します。
- アルゴリズムがテンプレートで指定されている場合、ハッシュアルゴリズム OID を作成し、IX509SignatureInformation オブジェクトに設定します。
- アルゴリズムがテンプレートで指定されている場合、非対称暗号化アルゴリズム OID を作成し、IX509SignatureInformation オブジェクトに設定します。
- IX509PrivateKey の多くのプロパティをテンプレート設定から設定します。
CSPInformations プロパティが NULL の場合、このメソッドはコンピューターにインストールされているプロバイダーから ICspInformations コレクションを作成します。
IX509PrivateKey オブジェクトと証明書テンプレートを使用して証明書要求を初期化します。(IX509CertificateRequestCertificate2.InitializeFromPrivateKeyTemplate)
| Context | X509CertificateEnrollmentContext | in | 要求される証明書がエンドユーザー向けか、コンピューター向けか、またはコンピューターの代理として動作する管理者向けかを指定する X509CertificateEnrollmentContext 列挙値です。次のいずれかの値を指定できます。ただし、秘密キーの MachineContext プロパティが設定されている場合は、ContextMachine 列挙値を指定する必要があります。
| ||||||||
| pPrivateKey | IX509PrivateKey* | inoptional | 秘密キーを表す IX509PrivateKey インターフェイスへのポインターです。 | ||||||||
| pPolicyServer | IX509EnrollmentPolicyServer* | inoptional | pTemplate パラメーターで指定されたテンプレートを含む証明書登録ポリシー(CEP)サーバーを表す IX509EnrollmentPolicyServer オブジェクトへのポインターです。 | ||||||||
| pTemplate | IX509CertificateTemplate* | inoptional | 初期化中に使用するテンプレートを表す IX509CertificateTemplate オブジェクトへのポインターです。 |
戻り値
関数が成功すると、S_OK を返します。
関数が失敗すると、エラーを示す HRESULT 値を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。
| 戻り値 | 説明 |
|---|---|
| pPrivateKey、pPolicyServer、または pTemplate パラメーターが NULL です。 | |
|
証明書要求オブジェクトは既に初期化されています。 |
解説(Remarks)
InitializeFromPrivateKeyTemplate メソッドは、次の処理を実行します。
- テンプレートで指定された拡張を IX509Extensions コレクションに追加します。
- IObjectIds コレクションを作成し、既定の XCN_OID_KEY_USAGE および XCN_OID_BASIC_CONSTRAINTS2 オブジェクト識別子を設定します。テンプレートがこれらの OID を重要(critical)でないと示している場合、それらはコレクションから削除されます。テンプレートによって重要とマークされた OID は追加されます。
- テンプレートが対称アルゴリズムをサポートしている場合、SmimeCapabilities プロパティを設定します。
- テンプレートが個別の署名アルゴリズム OID を必要とする場合、AlternateSignatureAlgorithm プロパティを設定します。
- IX509SignatureInformation オブジェクトを作成します。
- アルゴリズムがテンプレートで指定されている場合、ハッシュアルゴリズム OID を作成し、IX509SignatureInformation オブジェクトに設定します。
- 非対称暗号化アルゴリズム OID が存在する場合、テンプレートから取得し、IX509SignatureInformation オブジェクトに設定します。
- IX509PrivateKey の多くのプロパティをテンプレート設定から設定します。
CSPInformations プロパティが指定されていない場合、このメソッドはコンピューターにインストールされているプロバイダーから ICspInformations コレクションを作成します。
この時点では秘密キーは作成されません。メソッドに渡された IX509PrivateKey オブジェクトが既存のキーを表していない場合、キーは Encode メソッドが呼び出されたときに作成されます。テンプレートが指定されておらず、IX509PrivateKey の ProviderName プロパティが設定されていない場合、キーは既定のプロバイダーを使用して作成されます。秘密キーが存在する場合、それは PrivateKey プロパティに設定されます。
初期化中に使用されたテンプレートを含む証明書登録ポリシー(CEP)サーバーを取得します。(IX509CertificateRequestCertificate2.get_PolicyServer)
| ppPolicyServer | IX509EnrollmentPolicyServer** | out | 要求に関連付けられた IX509EnrollmentPolicyServer オブジェクトを受け取るポインタである。 |
初期化中に使用された証明書要求テンプレートを取得します。(IX509CertificateRequestCertificate2.get_Template)
| ppTemplate | IX509CertificateTemplate** | out | 要求に関連付けられた IX509CertificateTemplate オブジェクトを受け取るポインタである。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IX509CertificateRequestCertificate2 "{728AB35A-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX509CertificateRequestCertificate2 IID_IX509CertificateRequestCertificate2 "{}"
#comfunc global IX509CertificateRequestCertificate2_InitializeFromTemplate 71 int,sptr,sptr
#comfunc global IX509CertificateRequestCertificate2_InitializeFromPrivateKeyTemplate 72 int,sptr,sptr,sptr
#comfunc global IX509CertificateRequestCertificate2_get_PolicyServer 73 sptr
#comfunc global IX509CertificateRequestCertificate2_get_Template 74 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。