IX509CertificateRequest

IX509CertificateRequest インターフェイスは、証明書登録 (Certificate Enrollment) API によって実装される各要求オブジェクトに共通し、それらに継承されるメソッドとプロパティを識別する、抽象基底の証明書要求を表します。

ユーザーまたはコンピューターに対して要求オブジェクトを初期化します。

関数が成功すると、S_OK を返します。

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

Initialize メソッドは、作成される証明書要求の種類に応じてさまざまなオブジェクトを初期化します。このメソッドを IX509CertificateRequestPkcs10 オブジェクトから呼び出すと、秘密キーオブジェクトが作成され、次のオブジェクトが初期化されます:

• 空の ICryptAttributes コレクション。
• 空の IX509Extensions コレクション。
• 既定のクリティカル拡張オブジェクト識別子である XCN_OID_KEY_USAGE と XCN_OID_BASIC_CONSTRAINTS2 を含む IObjectIds コレクション。このコレクションは CriticalExtensions プロパティを呼び出して取得できます。
• SuppressOids プロパティ用の、空の IObjectIds コレクション。
• CSPInformations プロパティで指定した値、またはコンピューターにインストールされているすべてのプロバイダーのコレクションを含む ICspInformations オブジェクト。このコレクションは秘密キーの作成に使用されます。

このメソッドを IX509CertificateRequestCmc オブジェクトから呼び出すと、上記と同様に内部 PKCS #10 要求が作成され、次のオブジェクトが初期化されます:

• 空の ICryptAttributes コレクション。
• 空の IX509NameValuePairs コレクション。
• 空の IX509Extensions コレクション。
• 既定のクリティカル拡張オブジェクト識別子である XCN_OID_KEY_USAGE と XCN_OID_BASIC_CONSTRAINTS2 を含む IObjectIds コレクション。このコレクションは CriticalExtensions プロパティを呼び出して取得できます。
• SuppressOids プロパティ用の、空の IObjectIds コレクション。
• 空の ISignerCertificates コレクション。

このメソッドを IX509CertificateRequestPkcs7 オブジェクトから呼び出すと、上記と同様に内部 PKCS #10 要求が作成されます。

このメソッドを呼び出す前に、次のプロパティを呼び出すことができます。

• ParentWindow
• Silent
• UIContextMessage

ICspInformations コレクションを指定する場合は、このメソッドを呼び出す前に CSPInformations プロパティを呼び出す必要があります。

証明書要求に署名してエンコードし、キーペアが存在しない場合は作成します。

関数が成功すると、S_OK を返します。

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

PKCS #10 要求の場合、このメソッドは次を行います:

• 秘密キーを更新するか、必要に応じてキーを作成します。
• 秘密キーから公開キーを生成します。
• 拡張を更新し、既定の拡張を追加するとともに、抑制対象 OID コレクションおよびクリティカル拡張 OID コレクションを考慮します。
• 属性を更新し、既定の属性を追加するとともに、抑制対象 OID コレクションを考慮します。
• 更新された未署名の要求を組み立ててエンコードします。
• 署名を作成してエンコードします。
• 署名と未署名の要求をエンコードします。

CMC 要求の場合、このメソッドは次を行います:

• すべての内部要求オブジェクトをエンコードします。
• 外部要求オブジェクトの拡張を更新し、既定の拡張を追加するとともに、抑制対象 OID コレクションおよびクリティカル拡張 OID コレクションを考慮します。
• 外部要求オブジェクトの属性を更新し、既定の属性を追加するとともに、抑制対象 OID コレクションを考慮します。
• 名前と値のペアのコレクションを更新します。
• エンコードされた内部要求と更新された外部要求から成る CMC コンテンツをエンコードします。
• 各署名証明書に対して署名を作成してエンコードします。
• プライマリ署名を作成してエンコードします。
• エンコードされた CMC コンテンツ (内部要求と更新された外部要求を含む) と、エンコードされた署名を組み立てます。
• 組み立てたコンテンツを PKCS #7 メッセージにエンコードします。

要求オブジェクトの状態を、Encode メソッドが呼び出される前の状態に復元します。

関数が成功すると、S_OK を返します。

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

このメソッドを使用すると、証明機関 (CA) による要求の拒否に応じて、証明書要求を再構成 (再エンコードおよび再署名) できます。署名と生データはクリアされます。拡張と属性は Encode メソッドが呼び出される前の値にリセットされますが、クリティカル拡張フラグはリセットされません。CMC 要求オブジェクトの場合、入れ子になった各要求もリセットされます。

このメソッドは通常、秘密キーが暗号化されて要求に含まれる CMC キーアーカイブ要求で使用されます。

入れ子になった要求オブジェクトを取得します。

関数が成功すると、S_OK を返します。

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

最上位の要求オブジェクトは、PKCS #10、PKCS #7、または CMC 要求のいずれかです。内部要求オブジェクトには次の規則が適用されます:

• PKCS #10 要求は、内部要求オブジェクトを含むことができません。
• PKCS #7 要求は、PKCS #10 の内部要求オブジェクトのみを含むことができます。
• CMC 要求は、CMC または PKCS #10 の内部要求オブジェクトを含むことができます。内部 CMC 要求を含む CMC 要求では、最終的な内部 PKCS #10 要求に到達するまでに存在できる入れ子レベルの数に理論上の制限はありません。つまり、最上位の CMC 要求は内部 CMC 要求を含むことができ、その内部 CMC 要求もさらに内部 CMC 要求を含む、というように続きます。

要求オブジェクトの種類を指定する値を取得します。

このプロパティを GetInnerRequest メソッドと組み合わせて使用し、内部要求オブジェクトの種類を判別できます。

証明書がコンピューター向けかユーザー向けかを指定する値を取得します。

PKCS #7 または CMC 要求の場合、プロパティ値は内部要求オブジェクトから取得されます。

証明書登録 (エンロール) の処理中に、キー関連のモーダルダイアログのいずれかを表示するかどうかを示すブール値を指定または取得します。(Get)

このプロパティ値は、次の処理を行うキー関連の証明書登録コントロール (Certificate Enrollment Control) のモーダルダイアログで使用されます:

• スマートカードの挿入をユーザーに指示する
• スマートカードの PIN 番号を要求する
• 新しいキーの保護レベルを要求する
• キーにアクセスする前にユーザーのパスワードを要求する

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、プロパティ値は内部要求とすべての署名証明書で更新されます。

証明書要求が入れ子の要求を含んでいて、最上位の要求に Silent プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

証明書登録 (エンロール) の処理中に、キー関連のモーダルダイアログのいずれかを表示するかどうかを示すブール値を指定または取得します。(Put)

このプロパティ値は、次の処理を行うキー関連の証明書登録コントロール (Certificate Enrollment Control) のモーダルダイアログで使用されます:

• スマートカードの挿入をユーザーに指示する
• スマートカードの PIN 番号を要求する
• 新しいキーの保護レベルを要求する
• キーにアクセスする前にユーザーのパスワードを要求する

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、プロパティ値は内部要求とすべての署名証明書で更新されます。

証明書要求が入れ子の要求を含んでいて、最上位の要求に Silent プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

キー関連のユーザーインターフェイスダイアログで使用されるウィンドウの ID を指定および取得します。(Get)

このプロパティ値は、次の処理を行うキー関連の証明書登録コントロール (Certificate Enrollment Control) のモーダルダイアログで使用されます:

• スマートカードの挿入をユーザーに指示する
• スマートカードの PIN 番号を要求する
• 新しいキーの保護レベルを要求する
• キーにアクセスする前にユーザーのパスワードを要求する

アプリケーションがキー関連のモーダルダイアログを使用する場合は、このプロパティを使用して、ウィンドウが他のウィンドウの前面に表示され、スレッドのブロックが解除される前に要求されたアクションが実行されるようにすることをお勧めします。

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。証明書要求が入れ子の要求を含んでいて、最上位の要求に ParentWindow プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、ウィンドウ ID は内部要求とすべての署名証明書で更新されます。

キー関連のユーザーインターフェイスダイアログで使用されるウィンドウの ID を指定および取得します。(Put)

このプロパティ値は、次の処理を行うキー関連の証明書登録コントロール (Certificate Enrollment Control) のモーダルダイアログで使用されます:

• スマートカードの挿入をユーザーに指示する
• スマートカードの PIN 番号を要求する
• 新しいキーの保護レベルを要求する
• キーにアクセスする前にユーザーのパスワードを要求する

アプリケーションがキー関連のモーダルダイアログを使用する場合は、このプロパティを使用して、ウィンドウが他のウィンドウの前面に表示され、スレッドのブロックが解除される前に要求されたアクションが実行されるようにすることをお勧めします。

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。証明書要求が入れ子の要求を含んでいて、最上位の要求に ParentWindow プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、ウィンドウ ID は内部要求とすべての署名証明書で更新されます。

ユーザーインターフェイスに表示するコンテキスト文字列を指定または取得します。(Get)

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、プロパティ値は内部要求とすべての署名証明書で更新されます。

コンテキスト文字列には、アクションに関する追加情報を含める必要があります。たとえば、ユーザーインターフェイスがスマートカードの PIN の入力をユーザーに指示する場合、コンテキスト文字列は、要求に署名できるようにユーザーの本人確認のために PIN が使用されることを示すことができます。

ユーザーインターフェイスに表示するコンテキスト文字列を指定または取得します。(Put)

このプロパティは、初期化メソッドや Encode メソッドを呼び出す前に設定できます。PKCS #10 要求の場合、キーが存在すれば、プロパティ値は関連付けられた IX509PrivateKey オブジェクトから取得され、そこに設定されます。PKCS #7 または CMC 要求の場合、プロパティ値は内部要求とすべての署名証明書で更新されます。

コンテキスト文字列には、アクションに関する追加情報を含める必要があります。たとえば、ユーザーインターフェイスがスマートカードの PIN の入力をユーザーに指示する場合、コンテキスト文字列は、要求に署名できるようにユーザーの本人確認のために PIN が使用されることを示すことができます。

既定の拡張と属性を要求に含めるかどうかを示すブール値を指定または取得します。(Get)

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。証明書要求に既定の拡張と属性を含めてエンコードすることを抑制するには、Encode メソッドを呼び出す前にこのプロパティを設定します。

既定の拡張と属性を要求に含めるかどうかを示すブール値を指定または取得します。(Put)

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。証明書要求に既定の拡張と属性を含めてエンコードすることを抑制するには、Encode メソッドを呼び出す前にこのプロパティを設定します。

更新対象の、Distinguished Encoding Rules (DER) でエンコードされた証明書を格納するバイト配列を指定または取得します。(Get)

証明書は、Abstract Syntax Notation One (ASN.1) 標準で定義されている DER を使用してエンコードされます。エンコード処理によってバイト配列が作成されます。このバイト配列は、純粋なバイナリシーケンスか、テキストとして表示できるように Unicode でエンコードされた文字列として返されます。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

更新対象の、Distinguished Encoding Rules (DER) でエンコードされた証明書を格納するバイト配列を指定または取得します。(Put)

証明書は、Abstract Syntax Notation One (ASN.1) 標準で定義されている DER を使用してエンコードされます。エンコード処理によってバイト配列が作成されます。このバイト配列は、純粋なバイナリシーケンスか、テキストとして表示できるように Unicode でエンコードされた文字列として返されます。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

要求を作成した実行可能ファイルを識別する値を指定および取得します。(Get)

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

要求を作成した実行可能ファイルを識別する値を指定および取得します。(Put)

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

要求オブジェクトが使用できる暗号化プロバイダーのコレクションを指定および取得します。(Get)

プロバイダーのコレクションを指定する場合は、Initialize メソッドを呼び出す前にこのプロパティを設定する必要があります。指定するコレクションには、コンピューターに現在インストールされているすべてのプロバイダーを含める必要があります。サブセットまたはスーパーセットを指定した場合、このプロパティの動作は未定義です。

コレクションを指定しない場合、Initialize メソッドは、コンピューターにインストールされているすべてのプロバイダーのコレクションをプロパティ値として設定します。

CspInformations プロパティは、要求オブジェクトにコレクションを埋めさせる処理を呼び出し側が回避できるようにするために存在します。これは、呼び出し側が 1 つのセッションで複数の要求を作成する場合に役立ちます。

要求オブジェクトが使用できる暗号化プロバイダーのコレクションを指定および取得します。(Put)

プロバイダーのコレクションを指定する場合は、Initialize メソッドを呼び出す前にこのプロパティを設定する必要があります。指定するコレクションには、コンピューターに現在インストールされているすべてのプロバイダーを含める必要があります。サブセットまたはスーパーセットを指定した場合、このプロパティの動作は未定義です。

コレクションを指定しない場合、Initialize メソッドは、コンピューターにインストールされているすべてのプロバイダーのコレクションをプロパティ値として設定します。

CspInformations プロパティは、要求オブジェクトにコレクションを埋めさせる処理を呼び出し側が回避できるようにするために存在します。これは、呼び出し側が 1 つのセッションで複数の要求を作成する場合に役立ちます。

証明書要求の署名に使用するハッシュアルゴリズムのオブジェクト識別子 (OID) を指定および取得します。(Get)

証明書要求が入れ子の要求を含んでいて、最上位の要求に HashAlgorithm プロパティを設定すると、その値はすべての内部要求に自動的に伝播され、以前に設定されていた可能性のある値が上書きされます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

証明書要求の署名に使用するハッシュアルゴリズムのオブジェクト識別子 (OID) を指定および取得します。(Put)

証明書要求が入れ子の要求を含んでいて、最上位の要求に HashAlgorithm プロパティを設定すると、その値はすべての内部要求に自動的に伝播され、以前に設定されていた可能性のある値が上書きされます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

PKCS の署名アルゴリズムのオブジェクト識別子 (OID) を対象とするかどうかを示すブール値を指定および取得します。(Get)

独立したアルゴリズムは、ハッシュアルゴリズムと署名アルゴリズムそれぞれに対する個別の オブジェクト識別子 (OID) で表されます。例として次の値があります。

結合アルゴリズムは、ハッシュアルゴリズムと署名アルゴリズムの両方を識別する単一の OID で表されます。例として次の値があります。

証明書要求が入れ子の要求を含んでいて、最上位の要求に AlternateSignatureAlgorithm プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

PKCS #7 または CMC 要求の場合、このプロパティは内部 PKCS #10 要求のプライマリ署名に対するブール値を取得します。入力時には、すべての署名者証明書が指定されたプロパティ値で更新されます。

RSA 公開キーアルゴリズムを使用する PKCS #10 要求または証明書署名の場合、プロパティ値が False (結合 OID を示す) はバージョン 1.5 署名を意味し、True (独立 OID) はバージョン 2.1 署名を意味します。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

PKCS の署名アルゴリズムのオブジェクト識別子 (OID) を対象とするかどうかを示すブール値を指定および取得します。(Put)

独立したアルゴリズムは、ハッシュアルゴリズムと署名アルゴリズムそれぞれに対する個別の オブジェクト識別子 (OID) で表されます。例として次の値があります。

結合アルゴリズムは、ハッシュアルゴリズムと署名アルゴリズムの両方を識別する単一の OID で表されます。例として次の値があります。

証明書要求が入れ子の要求を含んでいて、最上位の要求に AlternateSignatureAlgorithm プロパティを設定すると、その値はすべての内部要求に自動的に伝播されます。ただし、各内部オブジェクトに対して手動でプロパティを設定することもできます。

PKCS #7 または CMC 要求の場合、このプロパティは内部 PKCS #10 要求のプライマリ署名に対するブール値を取得します。入力時には、すべての署名者証明書が指定されたプロパティ値で更新されます。

RSA 公開キーアルゴリズムを使用する PKCS #10 要求または証明書署名の場合、プロパティ値が False (結合 OID を示す) はバージョン 1.5 署名を意味し、True (独立 OID) はバージョン 2.1 署名を意味します。

このプロパティを呼び出す前に、要求オブジェクトを初期化する必要があります。このプロパティは Encode メソッドを呼び出す前に呼び出すことができます。

署名済みで、Distinguished Encoding Rules (DER) でエンコードされた証明書要求を格納するバイト配列を取得します。

Encode メソッドを呼び出して、Abstract Syntax Notation One (ASN.1) 標準で定義されている DER を使用して証明書要求をエンコードします。エンコード処理によってバイト配列が作成され、RawData プロパティはそれを文字列として返します。この文字列は、純粋なバイナリシーケンスか、テキストとして表示できるように Unicode でエンコードされたものです。