ICEnroll4

ICEnroll4 インターフェイスは、証明書登録コントロール (Certificate Enrollment Control) を表す複数のインターフェイスの 1 つです。

PKCS で秘密キーをアーカイブするために使用される証明書を設定または取得します。(Put)

PKCS で秘密キーをアーカイブするために使用される証明書を設定または取得します。(Get)

証明書データのハッシュを設定または取得します。(Put)

拇印 (thumbprint) は、保留中の証明書を指し示すために使用されます。

証明書データのハッシュを設定または取得します。(Get)

拇印 (thumbprint) は、保留中の証明書を指し示すために使用されます。

バイナリデータの BLOB を文字列に変換します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

エンコードされた文字列をバイナリデータの BLOB に変換します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

ICEnroll4::addExtensionToRequest メソッドは、要求に拡張を追加します。

VB

証明書要求に属性を追加します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

認証されていない名前と値の文字列ペアを要求に追加します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

要求からすべての拡張を削除します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

要求からすべての属性を削除します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

PKCS を作成します。(ICEnroll4.createRequest)

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

このメソッドがスクリプトから呼び出されると、証明書要求の作成をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。.pvk ファイルまたは .spc ファイルが指定された場合は、ファイルシステムへの書き込み操作をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

例

BSTR bstrDN = NULL;
BSTR bstrReq = NULL;
ICEnroll4 * pEnroll4 = NULL;
HRESULT hr;

hr = CoInitializeEx( NULL, COINIT_APARTMENTTHREADED );
if (FAILED(hr))
{
    printf("Failed CoInitializeEx - %x\n", hr);
    goto error;
}

hr = CoCreateInstance( __uuidof(CEnroll),
                       NULL,
                       CLSCTX_INPROC_SERVER,
                       __uuidof(ICEnroll4),
                       (void **)&pEnroll4);
if (FAILED(hr))
{
    printf("Failed CoCreateInstance - pEnroll4 [%x]\n", hr);
    goto error;
}

// generate the DN for the cert request
bstrDN = SysAllocString( TEXT("CN=Your Name")   // common name
                         TEXT(",OU=Your Unit")  // org unit
                         TEXT(",O=Your Org")    // organization
                         TEXT(",L=Your City")   // locality
                         TEXT(",S=Your State")  // state
                         TEXT(",C=Your Country") );  // country/region

// create the CMC request
hr = pEnroll4->createRequest( XECR_CMC,
                              bstrDN,
                              NULL,
                              &bstrReq );
if (FAILED(hr))
{
        printf("Failed createRequest - pEnroll4 [%x]\n", hr);
        goto error;
}
else
    // do something with the CMC (bstrReq);

error:

//clean up resources, and so on
if ( bstrDN )
    SysFreeString( bstrDN );
if ( bstrReq )
    SysFreeString( bstrReq );
if ( pEnroll4 )
    pEnroll4->Release();

CoUninitialize();

PKCS を作成します。(ICEnroll4.createFileRequest)

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

このメソッドがスクリプトから呼び出されると、証明書要求の作成をユーザーが許可するかどうか、およびファイルシステムへの書き込み操作をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

以前の createRequest の呼び出しに応答して発行された資格情報の配信を受け入れ、その資格情報を適切なストアに格納します。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

応答には証明書がちょうど 1 つだけ含まれている必要があります。子証明書を含めることはできません。

応答は PKCS #7 または完全な CMC 応答のいずれかです。ただし、完全な CMC 応答を受け入れるには、暗号化サービスプロバイダー が CMC 構造の Abstract Syntax Notation One (ASN.1) エンコードをサポートしている必要があります。

このメソッドがスクリプトから呼び出されると、証明書のインストールをユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

以前の createFileRequest の呼び出しに応答して発行された資格情報の配信を受け入れ、その資格情報を適切なストアに格納します。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

strResponseFileName パラメーターで指定される応答には、証明書がちょうど 1 つだけ含まれている必要があります。子証明書を含めることはできません。

応答は PKCS #7 または完全な CMC 応答のいずれかです。ただし、完全な CMC 応答を受け入れるには、暗号化サービスプロバイダー が CMC 構造の Abstract Syntax Notation One (ASN.1) エンコードをサポートしている必要があります。

このメソッドがスクリプトから呼び出されると、証明書のインストールをユーザーが許可するかどうか、およびファイルシステムからの読み取り操作をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

証明機関 (CA) の応答から証明書を取得します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

strResponse に含まれる応答には、証明書がちょうど 1 つだけ含まれている必要があります。子証明書を含めることはできません。

応答は PKCS #7 または完全な Certificate Management over CMS (CMC) 応答のいずれかです。ただし、完全な CMC 応答を受け入れるには、暗号化サービスプロバイダー (CSP) が CMC 構造の Abstract Syntax Notation One (ASN.1) エンコードをサポートしている必要があります。

証明機関 (CA) からの応答を含むファイルから証明書を取得します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

VB

strResponseFileName に含まれる応答には、証明書がちょうど 1 つだけ含まれている必要があります。子証明書を含めることはできません。

応答は PKCS #7 または完全な Certificate Management over CMS (CMC) 応答のいずれかです。ただし、完全な CMC 応答を受け入れるには、暗号化サービスプロバイダー (CSP) が CMC 構造の Abstract Syntax Notation One (ASN.1) エンコードをサポートしている必要があります。

このメソッドがスクリプトから呼び出されると、ファイルシステムからの読み取り操作をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

受け入れた証明書チェーンと秘密キーを Personal Information Exchange (PFX) 形式の文字列に保存します。PFX 形式は PKCS とも呼ばれます。(ICEnroll4.createPFX)

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

このメソッドは、証明書登録コントロール (Certificate Enrollment Control) がスクリプト化されたコントロールとして実行される場合は無効になります。

受け入れた証明書チェーンと秘密キーを Personal Information Exchange (PFX) 形式でファイルに保存します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

このメソッドがスクリプトから呼び出されると、ファイルシステムへの書き込み操作をユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

保留中の要求のプロパティを設定します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

保留中の証明書要求を列挙し、それぞれから指定されたプロパティを取得します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

lDesiredProperty に次の値が指定された場合、このメソッドは E_NOTIMPL を返します。

• XEPR_DATE
• XEPR_V1TEMPLATENAME
• XEPR_V2TEMPLATEOID
• XEPR_VERSION

lDesiredProperty にその他の値を指定した場合、このメソッドは E_INVALIDARG を返します。

VB

このメソッドは、証明書登録コントロール (Certificate Enrollment Control) がスクリプト化されたコントロールとして実行される場合は無効になります。

クライアントの要求ストアから保留中の要求を削除します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

署名キーおよび交換キーのサイズ情報を取得します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

VB

CSP がこのメソッドをサポートしていない場合は、エラーが返されます。

XEKL_KEYSIZE_INC 値の詳細については、 CryptGetProvParam リファレンスページの PP_SIG_KEYSIZE_INC の使用方法を参照してください。

例

DWORD dwExchMin, dwExchMax, dwSignDef, dwSignInc;

// Determine the minimum and maximum key length values.
// hr is HRESULT variable.
hr = pEnroll4->GetKeyLenEx( XEKL_KEYSIZE_MIN,
                            XEKL_KEYSPEC_KEYX,
                            &dwExchMin );
if ( FAILED( hr ) )    
    printf("Failed GetKeyLenEx for Exchange Minimum [%x]\n", hr);
else
    printf("Exchange key Min: %d\n", dwExchMin);

hr = pEnroll4->GetKeyLenEx( XEKL_KEYSIZE_MAX,
                            XEKL_KEYSPEC_KEYX,
                            &dwExchMax );
if ( FAILED( hr ) )
    printf("Failed GetKeyLenEx for Exchange Maximum [%x]\n", hr);
else
    printf("Exchange key Max: %d\n", dwExchMax );

hr = pEnroll4->GetKeyLenEx( XEKL_KEYSIZE_DEFAULT,
                            XEKL_KEYSPEC_SIG,
                            &dwSignDef );
if ( FAILED( hr ) )
    printf("Failed GetKeyLenEx for Signature Default "
   "Key size [%x]\n", hr);
else
    printf("Signature key default size: %d\n", dwSignDef );

hr = pEnroll4->GetKeyLenEx( XEKL_KEYSIZE_INC,
                            XEKL_KEYSPEC_SIG,
                            &dwSignInc );
if ( FAILED( hr ) )    
    printf("Failed GetKeyLenEx for Signature "
   "Key Size Increment [%x]\n", hr);
else
    printf("Signature key increment size: %d\n", dwSignInc );

証明書または証明書のチェーンを処理し、適切な証明書ストアに格納します。ローカルストアに実際にインストールされた証明書の数を返す点を除いて InstallPKCS7 と同じです。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

VB

このメソッドがスクリプトから呼び出されると、証明書のインストールをユーザーが許可するかどうかを尋ねるユーザーインターフェイスが表示されます。

証明書テンプレート (または "証明書の種類") を要求に追加します。

VB

このメソッドは新しい要求メソッドである createRequest のみをサポートします。 createPKCS10 メソッドはサポートしません。

このメソッドを複数回呼び出して、要求に対して複数の証明書テンプレートを設定できます。

指定された暗号化サービスプロバイダー (CSP) の種類を取得します。このメソッドは ICEnroll4 インターフェイスで初めて定義されました。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

VB

• PROV_RSA_FULL
• PROV_RSA_SIG
• PROV_DSS
• PROV_FORTEZZA
• PROV_MS_EXCHANGE
• PROV_SSL
• PROV_RSA_SCHANNEL
• PROV_DSS_DH
• PROV_DH_SCHANNEL

署名者の証明書を設定します。

クライアント ID 要求属性を設定または取得します。クライアント ID 要求属性は、証明書要求の発生元を示します。このプロパティは ICEnroll4 インターフェイスで初めて定義されました。(Put)

クライアント ID 要求属性を設定または取得します。クライアント ID 要求属性は、証明書要求の発生元を示します。このプロパティは ICEnroll4 インターフェイスで初めて定義されました。(Get)

証明書に BLOB プロパティを追加します。

BLOB のプロパティをリセットします。

生成される証明書要求にサブジェクトキー ID 拡張を追加するかどうかを決定します。(Put)

生成される証明書要求にサブジェクトキー ID 拡張を追加するかどうかを決定します。(Get)