ホーム › Security.Cryptography.Certificates › ICspStatus

ICspStatus

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID728ab309-217d-11da-b2a4-000e7bbb2b09継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

暗号化プロバイダー/アルゴリズムのペアに関する情報を格納します。(ICspStatus)

メソッド 7

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

vtbl 7 HRESULT Initialize(ICspInformation* pCsp, ICspAlgorithm* pAlgorithm)

暗号化プロバイダーと関連付けられたアルゴリズムからオブジェクトを初期化します。

pCsp	ICspInformation*	inoptional	プロバイダーに関する情報を表す ICspInformation インターフェイスへのポインター。
pAlgorithm	ICspAlgorithm*	inoptional	pCsp パラメーターで指定されたプロバイダーがサポートするアルゴリズムを表す ICspAlgorithm インターフェイスへのポインター。このパラメーターは省略可能で、NULL を指定できます。

戻り値

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

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

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

解説(Remarks)

Initialize メソッドは、指定した ICspInformation オブジェクトと ICspAlgorithm オブジェクトを、CspInformation プロパティおよび CspAlgorithm プロパティに保存します。また、空の IX509EnrollmentStatus オブジェクトを作成し、EnrollmentStatus プロパティに保存します。

ICspStatuses コレクションは、通常 IX509CertificateRequestPkcs10 オブジェクトによって初期化されます。Initialize メソッドは、カスタムコレクションに追加する ICspStatus オブジェクトを作成できるように用意されています。

vtbl 8 HRESULT get_Ordinal(INT* pValue)

ICspStatuses コレクション内の ICspStatus オブジェクトの位置を指定または取得します。(Get)

pValue

INT*

out

この状態の表示順序を表す序数を受け取る INT へのポインタである。

解説(Remarks)

ICspStatuses コレクションを序数で反復処理するには、ItemByOrdinal プロパティを呼び出します。コレクション内の ICspStatus オブジェクトの序数順は、コレクションを列挙するたびに、次のようなさまざまな理由により変化する可能性があります(これらに限定されません)。

証明書要求テンプレートの設定
暗号化プロバイダーのプロパティ値
秘密キーのプロパティ値

たとえば、証明書要求の作成に選択されたバージョン 2 テンプレートが、証明書を署名にのみ使用できると指定しており(pKIDefaultKeySpec テンプレート属性が XCN_AT_SIGNATURE)、既定のプロバイダーが Microsoft Enhanced RSA and AES Cryptographic Provider であるとします。プロバイダーが暗号化アルゴリズムと署名アルゴリズムの両方をサポートしているにもかかわらず、テンプレートが証明書を署名に制限している点に注意してください。つまり、プロバイダーの KeySpec プロパティは XCN_AT_KEYEXCHANGE 定数と XCN_AT_SIGNATURE 定数のビット単位の組み合わせですが、pKIDefaultKeySpec テンプレート属性は XCN_AT_SIGNATURE のみをサポートします。

コレクション内の ICspStatus オブジェクトは、次のように並べ替えられます。

このプロバイダーに対して列挙された ICspStatus オブジェクトのうち、署名アルゴリズム(XCN_AT_SIGNATURE)に関連付けられたものが最初に(序数値が小さい方に)並べられ、それらの Display プロパティと Selected プロパティが有効になります。
注意 pKIDefaultKeySpec テンプレート属性が XCN_AT_KEYEXCHANGE であった場合は、暗号化アルゴリズムが最初に並べられます。
このプロバイダーに対して列挙された ICspStatus オブジェクトのうち、暗号化アルゴリズム(XCN_AT_KEYEXCHANGE)に関連付けられたものが後に(序数値が大きい方に)並べられ、それらの Display プロパティと Selected プロパティは有効になりません。
非対称署名アルゴリズム(XCN_AT_SIGNATURE)をサポートするが、指定されたプロバイダーに関連付けられていない、インストール済みのその他すべての CryptoAPI プロバイダーについては、Display プロパティが有効になり、Selected プロパティは有効になりません。
非対称暗号化アルゴリズム(XCN_AT_KEYEXCHANGE)をサポートする、インストール済みのその他すべての CryptoAPI プロバイダーについては、Display プロパティと Selected プロパティは有効になりません。
インストール済みのすべての Cryptography API: Next Generation (CNG) プロバイダーについては、Display プロパティと Selected プロパティは有効になりません。

別の例として、バージョン 3 テンプレートが特定の CNG プロバイダーとアルゴリズムを 1 つ指定しているとします。そのプロバイダー/アルゴリズムのペア(ICspStatus オブジェクト)が最初に並べられ、表示が有効かつ選択された状態になります。そのプロバイダーがサポートするその他すべてのアルゴリズムは後に並べられ、表示は有効にならず、選択もされません。指定されたアルゴリズムをサポートするその他すべてのプロバイダーは、さらに後に並べられ、表示は有効になりますが、選択はされません。残りのプロバイダー/アルゴリズムのペアはすべて、表示が有効にならず、選択もされません。

注意 CNG プロバイダーは、KeySpec の使用目的の概念をサポートしません。このプロパティ値として XCN_AT_NONE を返します。

vtbl 9 HRESULT put_Ordinal(INT Value)

ICspStatuses コレクション内の ICspStatus オブジェクトの位置を指定または取得します。(Put)

Value

INT

この状態の表示順序を表す序数を指定する。

解説(Remarks)

証明書要求テンプレートの設定
暗号化プロバイダーのプロパティ値
秘密キーのプロパティ値

コレクション内の ICspStatus オブジェクトは、次のように並べ替えられます。

このプロバイダーに対して列挙された ICspStatus オブジェクトのうち、署名アルゴリズム(XCN_AT_SIGNATURE)に関連付けられたものが最初に(序数値が小さい方に)並べられ、それらの Display プロパティと Selected プロパティが有効になります。
注意 pKIDefaultKeySpec テンプレート属性が XCN_AT_KEYEXCHANGE であった場合は、暗号化アルゴリズムが最初に並べられます。
このプロバイダーに対して列挙された ICspStatus オブジェクトのうち、暗号化アルゴリズム(XCN_AT_KEYEXCHANGE)に関連付けられたものが後に(序数値が大きい方に)並べられ、それらの Display プロパティと Selected プロパティは有効になりません。
非対称署名アルゴリズム(XCN_AT_SIGNATURE)をサポートするが、指定されたプロバイダーに関連付けられていない、インストール済みのその他すべての CryptoAPI プロバイダーについては、Display プロパティが有効になり、Selected プロパティは有効になりません。
非対称暗号化アルゴリズム(XCN_AT_KEYEXCHANGE)をサポートする、インストール済みのその他すべての CryptoAPI プロバイダーについては、Display プロパティと Selected プロパティは有効になりません。
インストール済みのすべての Cryptography API: Next Generation (CNG) プロバイダーについては、Display プロパティと Selected プロパティは有効になりません。

注意 CNG プロバイダーは、KeySpec の使用目的の概念をサポートしません。このプロパティ値として XCN_AT_NONE を返します。

vtbl 10 HRESULT get_CspAlgorithm(ICspAlgorithm** ppValue)

プロバイダーがサポートするアルゴリズムに関する情報を格納する ICspAlgorithm オブジェクトを取得します。

ppValue

ICspAlgorithm**

out

関連付けられた ICspAlgorithm オブジェクトを受け取るインターフェイスポインタへのポインタである。

解説(Remarks)

ICspAlgorithm オブジェクトには、アルゴリズムに関する次の情報が含まれます。

キーの既定の長さ、最小の長さ、最大の長さ、および増分の長さ。
アルゴリズムの略称および正式名称。
アルゴリズムが実行できる暗号化操作。

vtbl 11 HRESULT get_CspInformation(ICspInformation** ppValue)

プロバイダーに関する一般的な情報を格納する ICspInformation オブジェクトを取得します。

ppValue

ICspInformation**

out

関連付けられた ICspInformation オブジェクトを受け取るインターフェイスポインタへのポインタである。

解説(Remarks)

ICspInformation オブジェクトには、CSP に関する次の情報が含まれます。

サポートされるアルゴリズムとその使用目的のコレクション。
CSP がハードウェアとソフトウェアのどちらで実装されているか。
CSP がスマートカードプロバイダーとレガシプロバイダーのどちらであるか。
バージョン番号と名前。
CSP がクライアントコンピューターにインストールされているかどうか。

vtbl 12 HRESULT get_EnrollmentStatus(IX509EnrollmentStatus** ppValue)

証明書の登録(エンロール)に関する情報を格納する IX509EnrollmentStatus オブジェクトを取得します。

ppValue

IX509EnrollmentStatus**

out

関連付けられた登録状態を表す IX509EnrollmentStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。

解説(Remarks)

このプロパティは IX509EnrollmentStatus オブジェクトを返します。このオブジェクトは、通常 PKCS #10 証明書要求を作成するときに設定されます。このオブジェクトが返す次の 3 つのプロパティは、ICspStatus オブジェクトが表すプロバイダー/アルゴリズムのペアに関する情報を提供します。

Display プロパティは、プロバイダーとアルゴリズムをユーザーインターフェイスに表示するかどうかを指定します。
Selected プロパティは、証明書要求のキーペアの作成にプロバイダーとアルゴリズムを使用できるかどうかを指定します。
Status プロパティは、要求の初期化中にプロバイダーとアルゴリズムがスキップされたか、またはエラーになったかを指定します。

これらのプロパティがどのように重要かを理解するために、証明書要求が特定のプロバイダーとアルゴリズムを指定するテンプレートに基づいているとします。このプロバイダー/アルゴリズムのペアの Display プロパティと Status プロパティは有効になります。その他の ICspStatus オブジェクトでは、これらのプロパティの一方または両方が有効にならない場合があります。より完全な例については、Ordinal プロパティを参照してください。

Status プロパティは、IX509EnrollmentStatus オブジェクトが最初に作成されたときに EnrollUnknown に設定されます。プロバイダー/アルゴリズムのペアが選択されていない場合、ステータスは EnrollSkipped に設定されることがあります。証明書の初期化中に、選択されたプロバイダーとアルゴリズムでキーの作成が失敗した場合、ステータスは EnrollError に設定されます。

vtbl 13 HRESULT get_DisplayName(LPWSTR* pValue)

プロバイダーの名前、アルゴリズム名、およびアルゴリズムが実行できる操作を格納する文字列を取得します。

pValue

LPWSTR*

out

この CSP 状態の表示名を受け取る文字列ポインタである。

解説(Remarks)

このプロパティが返す文字列の形式は、プロバイダーが CryptoAPI の暗号化サービスプロバイダー (CSP) か、Cryptography API: Next Generation (CNG) プロバイダーのどちらであるかによって異なります。

CSP の場合の文字列の形式は ProviderName(KeyType) で、KeyType は "Signature" または "Encryption" のいずれかです。
CNG プロバイダーの場合の文字列の形式は AlgorithmName,ProviderName で、AlgorithmName は "Unknown Algorithm" になることがあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICspStatus "{728AB309-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global ICspStatus IID_ICspStatus "{}"
#comfunc global ICspStatus_Initialize            7 sptr,sptr
#comfunc global ICspStatus_get_Ordinal           8 var
#comfunc global ICspStatus_put_Ordinal           9 int
#comfunc global ICspStatus_get_CspAlgorithm      10 sptr
#comfunc global ICspStatus_get_CspInformation    11 sptr
#comfunc global ICspStatus_get_EnrollmentStatus  12 sptr
#comfunc global ICspStatus_get_DisplayName       13 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ICspStatus "{728AB309-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global ICspStatus IID_ICspStatus "{}"
#comfunc global ICspStatus_Initialize            7 sptr,sptr
#comfunc global ICspStatus_get_Ordinal           8 sptr
#comfunc global ICspStatus_put_Ordinal           9 int
#comfunc global ICspStatus_get_CspAlgorithm      10 sptr
#comfunc global ICspStatus_get_CspInformation    11 sptr
#comfunc global ICspStatus_get_EnrollmentStatus  12 sptr
#comfunc global ICspStatus_get_DisplayName       13 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。