CryptGetProvParam 関数 (wincrypt.h)

構文

BOOL CryptGetProvParam(
  [in]      HCRYPTPROV hProv,
  [in]      DWORD      dwParam,
  [out]     BYTE       *pbData,
  [in, out] DWORD      *pdwDataLen,
  [in]      DWORD      dwFlags
);

パラメーター

[in] hProv

クエリの CSP ターゲットのハンドル。 このハンドルは、 CryptAcquireContext 関数を使用して作成されている必要があります。

[in] dwParam

クエリの性質。 次のクエリが定義されています。

[out] pbData

データを受信するバッファーへのポインター。 このデータの形式は、 dwParam の値によって異なります。 dwParam が PP_USE_HARDWARE_RNG に設定されている場合は、pbData を NULL に設定する必要があります。

このパラメーターは、メモリ割り当て目的でこの情報のサイズを設定するために NULL にすることができます 。 詳細については、「不明な 長さのデータの取得」を参照してください。

[in, out] pdwDataLen

pbData パラメーターが指すバッファーのサイズをバイト単位で指定する DWORD 値へのポインター。 関数が戻るときに、 DWORD 値には、格納されているバイト数、またはバッファーに格納されるバイト数が含まれます。

[in] dwFlags

dwParam がPP_KEYSET_SEC_DESCRされている場合、キーが格納されているキー コンテナーのセキュリティ記述子が取得されます。 この場合、 dwFlags は、Platform SDK で定義されているように、要求されたセキュリティ情報を示す SECURITY_INFORMATION ビット フラグを渡すために使用されます。 SECURITY_INFORMATION ビット フラグは、ビットごとの OR 演算と組み合わせることができます。

次の値は、 PP_KEYSET_SEC_DESCRで使用するために定義されています。

次の値は、PP_ENUMALGS、PP_ENUMALGS_EX、およびPP_ENUMCONTAINERSで使用するために定義されています。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) になります。

関数が失敗した場合、戻り値は 0 (FALSE) になります。 拡張エラー情報については、 GetLastError を呼び出します。

NTE の前のエラー コードは、使用されている特定の CSP によって生成されます。 考えられるエラー コードの一部を次に示します。

注釈

この関数は、マルチスレッド プログラムのスレッドでは使用できません。

dwParam がPP_IMPTYPEの場合、pbData では次の値が返されます。

dwFlags パラメーターは、要求されたセキュリティ情報を示すSECURITY_INFORMATION ビット フラグを渡すために使用されます。 セキュリティ記述子へのポインターは pbData パラメーターで返され、セキュリティ記述子の長さは pdwDataLen パラメーターで返されます。 キー コンテナーのセキュリティは、 SetFileSecurity と GetFileSecurity で処理されます。

dwParam を PP_ENUMALGS または PP_ENUMALGS_EX に設定して列挙されたアルゴリズムのクラスを決定できます。 これは、サポートされている暗号化アルゴリズムの一覧を表示し、残りの部分を無視するために行われる場合があります。 GET_ALG_CLASS(x) マクロは、アルゴリズム識別子を引数として受け取り、そのアルゴリズムの一般的なクラスを示すコードを返します。 可能な戻り値は次のとおりです。

• ALG_CLASS_DATA_ENCRYPT
• ALG_CLASS_HASH
• ALG_CLASS_KEY_EXCHANGE
• ALG_CLASS_SIGNATURE

次の表に、Microsoft 基本暗号化プロバイダーでサポートされているアルゴリズムと、各アルゴリズムのクラスを示します。

アプリケーションでは、認識されないアルゴリズム識別子を持つアルゴリズムを使用することはできません。 不明な暗号化アルゴリズムを使用すると、予期しない結果が生じる可能性があります。

例

次の例は、暗号化サービス プロバイダー ハンドルに関連付けられている CSP の名前と、ハンドルに関連付けられているキー コンテナーの名前を見つける方法を示しています。 この例の完全なコンテキストについては、「 サンプル C プログラム: CryptAcquireContext の使用」を参照してください。

この関数を使用する別の例については、「 サンプル C プログラム: CSP プロバイダーとプロバイダーの種類の列挙」を参照してください。

//-----------------------------------------------------------------
//  Declare and initialize variables.

HCRYPTPROV hCryptProv;
BYTE       pbData[1000];       // 1000 will hold the longest 
                               // key container name.
DWORD cbData;

//-------------------------------------------------------------------
// An HCRYPTPROV must be acquired before using code like that in 
// "Example C Program Using CryptAcquireContext."

//-------------------------------------------------------------------
// Read the name of the default CSP.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_NAME, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded.\n");
    printf("Provider name: %s\n", pbData);
}
else
{
    printf("Error reading CSP name. \n");
    exit(1);
}
//--------------------------------------------------------------------
// Read the name of the default key container.

cbData = 1000;
if(CryptGetProvParam(
    hCryptProv, 
    PP_CONTAINER, 
    pbData, 
    &cbData, 
    0))
{
    printf("CryptGetProvParam succeeded. \n");
    printf("Key Container name: %s\n", pbData);
}
else
{
    printf("Error reading key container name. \n");
    exit(1);
}

要件

こちらもご覧ください

絶対セキュリティ記述子と Self-Relative セキュリティ記述子

CryptAcquireContext

CryptCreateHash

CryptDeriveKey

CryptGenKey

CryptGetKeyParam

CryptSetProvParam

サービス プロバイダー関数