BCryptQueryContextFunctionConfiguration 関数 (bcrypt.h)

  • [アーティクル]

[BCryptQueryContextFunctionConfiguration は、[要件] セクションで指定されたオペレーティング システムで使用できます。 これは、以降のバージョンで変更または使用できない可能性があります。

BCryptQueryContextFunctionConfiguration 関数は、既存の CNG コンテキストの暗号化関数構成情報を取得します。

構文

NTSTATUS BCryptQueryContextFunctionConfiguration(
  [in]      ULONG                          dwTable,
  [in]      LPCWSTR                        pszContext,
  [in]      ULONG                          dwInterface,
  [in]      LPCWSTR                        pszFunction,
  [in, out] ULONG                          *pcbBuffer,
  [in, out] PCRYPT_CONTEXT_FUNCTION_CONFIG *ppBuffer
);

パラメーター

[in] dwTable

コンテキストが存在する構成テーブルを識別します。 次のいずれかの値を指定できます。

値 意味
CRYPT_LOCAL
 コンテキストは、local-machine 構成テーブルに存在します。
CRYPT_DOMAIN
 この値は使用できません。

[in] pszContext

関数構成情報を取得するコンテキストの識別子を含む null で終わる Unicode 文字列へのポインター。

[in] dwInterface

関数構成情報を取得する暗号化インターフェイスを識別します。 次のいずれかの値を指定できます。

値 意味
BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE
 非対称暗号化関数の一覧から関数構成情報を取得します。
BCRYPT_CIPHER_INTERFACE
 暗号関数の一覧から関数構成情報を取得します。
BCRYPT_HASH_INTERFACE
 ハッシュ関数の一覧から関数構成情報を取得します。
BCRYPT_RNG_INTERFACE
 乱数ジェネレーター関数の一覧から関数構成情報を取得します。
BCRYPT_SECRET_AGREEMENT_INTERFACE
 シークレット アグリーメント関数の一覧から関数構成情報を取得します。
BCRYPT_SIGNATURE_INTERFACE
 シグネチャ関数の一覧から関数構成情報を取得します。
NCRYPT_KEY_STORAGE_INTERFACE
 キー ストレージ関数の一覧から関数構成情報を取得します。
NCRYPT_SCHANNEL_INTERFACE
 Schannel 関数の一覧から関数構成情報を取得します。

[in] pszFunction

構成情報を取得する暗号化関数の識別子を含む null で終わる Unicode 文字列へのポインター。

[in, out] pcbBuffer

入力時に ppBuffer が指すバッファーのサイズ (バイト単位) を含む ULONG 変数のアドレス。 このサイズがコンテキスト情報を保持するのに十分な大きさでない場合、この関数は STATUS_BUFFER_TOO_SMALLで失敗します。

この関数が戻った後、この変数には ppBuffer バッファーにコピーされたバイト数が含まれます。

[in, out] ppBuffer

この関数によって取得された関数構成情報を受け取る CRYPT_CONTEXT_FUNCTION_CONFIG 構造体へのポインターのアドレス。 pcbBuffer パラメーターが指す値には、このバッファーのサイズが含まれています。

このパラメーターが指す値が NULL の場合、この関数は必要なメモリを割り当てます。 このメモリは、このポインターを BCryptFreeBuffer 関数に渡すことによって不要になったときに解放する必要があります。

このパラメーターが NULL の場合、この関数は pcbBuffer パラメーターが指す変数に必要なサイズをバイト単位で配置し、 STATUS_BUFFER_TOO_SMALLを返します。

このパラメーターの使用方法の詳細については、「解説」を参照してください。

戻り値

関数の成功または失敗を示す状態コードを返します。

可能なリターン コードには、次のものが含まれますが、これらに限定されません。

リターン コード 説明
STATUS_SUCCESS
 関数は成功しました。
STATUS_BUFFER_TOO_SMALL
 ppBuffer パラメーターは NULL ではなく、pcbBuffer パラメーターが指す値は、コンテキストのセットを保持するのに十分な大きさではありません。
STATUS_INVALID_PARAMETER
 1 つ以上のパラメーターが無効です。
STATUS_NO_MEMORY
 メモリ割り当てエラーが発生しました。
STATUS_NOT_FOUND
 指定されたコンテキストまたは関数が見つかりませんでした。

注釈

各暗号化関数には構成情報のセットが 1 つしかないため、 ppBuffer パラメーターは配列として使用されているように見えますが、この関数はこれを 1 つの要素のみを持つ配列として扱います。 次の例は、このパラメーターの使用方法を明確にするのに役立ちます。

// Get the function configuration information.
CRYPT_CONTEXT_FUNCTION_CONFIG FuncConfig;
ULONG uSize = sizeof(FuncConfig);
PCRYPT_CONTEXT_FUNCTION_CONFIG pFuncConfig = &FuncConfig;
status = BCryptQueryContextFunctionConfiguration(
    CRYPT_LOCAL, 
    pszContext, 
    NCRYPT_SCHANNEL_INTERFACE,
    pszFunction,
    &uSize, 
    &pFuncConfig);

BCryptQueryContextFunctionConfiguration は、ユーザー モードでのみ呼び出すことができます。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー bcrypt.h
Library Bcrypt.lib
[DLL] Bcrypt.dll

こちらもご覧ください

CRYPT_CONTEXT_FUNCTION_CONFIG