BCryptGetProperty 関数 (bcrypt.h)

BCryptGetProperty 関数は、CNG オブジェクトの名前付きプロパティの値を取得します。

構文

NTSTATUS BCryptGetProperty(
  [in]  BCRYPT_HANDLE hObject,
  [in]  LPCWSTR       pszProperty,
  [out] PUCHAR        pbOutput,
  [in]  ULONG         cbOutput,
  [out] ULONG         *pcbResult,
  [in]  ULONG         dwFlags
);

パラメーター

[in] hObject

プロパティ値を取得する CNG オブジェクトを表すハンドル。

[in] pszProperty

取得するプロパティの名前を含む null で終わる Unicode 文字列へのポインター。 これには、定義済みの 暗号化プリミティブ プロパティ識別子 またはカスタム プロパティ識別子のいずれかを指定できます。

[out] pbOutput

プロパティ値を受け取るバッファーのアドレス。 cbOutput パラメーターには、このバッファーのサイズが含まれています。

[in] cbOutput

pbOutput バッファーのサイズ (バイト単位)。

[out] pcbResult

pbOutput バッファーにコピーされたバイト数を受け取る ULONG 変数へのポインター。 pbOutput パラメーターがNULL場合、この関数は必要なサイズ (バイト単位) をこのパラメーターが指す場所に配置します。

[in] dwFlags

この関数の動作を変更するフラグのセット。 この関数にはフラグは定義されていません。

ML-KEM の場合、このパラメーターは 0 に設定する必要があります。

戻り値

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

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

注釈

プロパティに必要なサイズを取得するには、pbOutput パラメーターのNULLを渡します。 この関数は、 pcbResult パラメーターが指す値に必要なサイズをバイト単位で配置します。

プロバイダーがサポートするプロセッサ モードに応じて、 BCryptGetProperty をユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVELIRQL または DISPATCH_LEVEL IRQL で実行できます。 現在の IRQL レベルが DISPATCH_LEVELされている場合、 BCryptGetProperty 関数に渡されるすべてのポインターは、非ページ (またはロックされた) メモリを参照する必要があります。 hObject パラメーターで指定されたオブジェクトがハンドルである場合は、BCRYPT_PROV_DISPATCH フラグを使用して開かれている必要があります。

BCRYPT_PARAMETER_SET_NAMEプロパティは、使用する前に BCrypt ML-DSA キーに設定する必要があります。 そのデータは、キー オブジェクトから取得できます。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.libを使用します。 Windows Server 2008 と Windows Vista: カーネル モードでこの関数を呼び出すには、 Ksecdd.libを使用します。

要求事項