ホーム › Security.Cryptography › BCryptQueryProviderRegistration

BCryptQueryProviderRegistration

関数

CNGプロバイダーの登録情報を照会して取得する。

DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptQueryProviderRegistration(
    LPCWSTR pszProvider,
    BCRYPT_QUERY_PROVIDER_MODE dwMode,
    BCRYPT_INTERFACE dwInterface,
    DWORD* pcbBuffer,
    CRYPT_PROVIDER_REG** ppBuffer   // optional
);

パラメーター

名前

型

方向

説明

pszProvider

LPCWSTR

情報を取得する対象のプロバイダー名を格納した、null 終端の Unicode 文字列へのポインター。

dwMode

BCRYPT_QUERY_PROVIDER_MODE

取得する情報の種類を指定します。次の値のいずれかを指定できます。

値	意味
CRYPT_ANY	プロバイダーの任意の情報を取得します。
CRYPT_UM	プロバイダーのユーザーモード情報を取得します。
CRYPT_KM	プロバイダーのカーネルモード情報を取得します。
CRYPT_MM	プロバイダーのユーザーモード情報とカーネルモード情報の両方を取得します。

dwInterface

BCRYPT_INTERFACE

情報を取得する対象のインターフェイスを指定します。次の値のいずれかを指定できます。

値	意味
BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE	非対称暗号化インターフェイスを取得します。
BCRYPT_CIPHER_INTERFACE	暗号 (cipher) インターフェイスを取得します。
BCRYPT_HASH_INTERFACE	ハッシュインターフェイスを取得します。
NCRYPT_KEY_STORAGE_INTERFACE	キーストレージインターフェイスを取得します。
BCRYPT_RNG_INTERFACE	乱数ジェネレーターインターフェイスを取得します。
NCRYPT_SCHANNEL_INTERFACE	Schannel インターフェイスを取得します。
BCRYPT_SECRET_AGREEMENT_INTERFACE	秘密協定 (secret agreement) インターフェイスを取得します。
BCRYPT_SIGNATURE_INTERFACE	署名インターフェイスを取得します。

pcbBuffer

DWORD*

inout

ULONG 値へのポインター。呼び出し時には、ppBuffer パラメーターが指すバッファーのサイズ (バイト単位) を格納します。戻り時には、この値にバッファーへコピーされたバイト数、または必要なバッファーのサイズ (バイト単位) のいずれかが格納されます。

注意これはバッファー全体の総サイズ (バイト単位) であり、CRYPT_PROVIDER_REG 構造体のサイズだけではありません。バッファーは、CRYPT_PROVIDER_REG 構造体に加えて、プロバイダーに関するその他のデータも保持できる必要があります。

ppBuffer

CRYPT_PROVIDER_REG**

outoptional

プロバイダーを記述する CRYPT_PROVIDER_REG 構造体およびその他のデータを受け取る、バッファーポインターへのポインター。

このパラメーターが NULL の場合、この関数は STATUS_BUFFER_TOO_SMALL を返し、pcbBuffer パラメーターが指す値に、すべてのデータに必要なサイズ (バイト単位) を格納します。

このパラメーターが NULL ポインターのアドレスである場合、この関数は必要なメモリを割り当て、プロバイダー情報を書き込み、このメモリへのポインターをこのパラメーターに格納します。このメモリの使用を終えたら、このポインターを BCryptFreeBuffer 関数に渡して解放してください。

このパラメーターが非 NULL ポインターのアドレスである場合、この関数はプロバイダー情報をこのバッファーにコピーします。pcbBuffer パラメーターには、バッファー全体のサイズ (バイト単位) を格納する必要があります。バッファーがすべてのプロバイダー情報を保持できる大きさでない場合、この関数は STATUS_BUFFER_TOO_SMALL を返します。

戻り値の型: NTSTATUS

公式ドキュメント

CNG プロバイダーに関する情報を取得します。

戻り値

関数の成否を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値コード	説明
STATUS_SUCCESS	関数は成功しました。
STATUS_INVALID_PARAMETER	1 つ以上のパラメーターが有効ではありません。
STATUS_BUFFER_TOO_SMALL	pcbBuffer パラメーターで指定されたサイズが、すべてのデータを保持するのに十分ではありません。
STATUS_NOT_FOUND	指定された条件に一致するプロバイダーが見つかりませんでした。

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptQueryProviderRegistration(
    LPCWSTR pszProvider,
    BCRYPT_QUERY_PROVIDER_MODE dwMode,
    BCRYPT_INTERFACE dwInterface,
    DWORD* pcbBuffer,
    CRYPT_PROVIDER_REG** ppBuffer   // optional
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptQueryProviderRegistration(
    [MarshalAs(UnmanagedType.LPWStr)] string pszProvider,   // LPCWSTR
    uint dwMode,   // BCRYPT_QUERY_PROVIDER_MODE
    uint dwInterface,   // BCRYPT_INTERFACE
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr ppBuffer   // CRYPT_PROVIDER_REG** optional, out
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptQueryProviderRegistration(
    <MarshalAs(UnmanagedType.LPWStr)> pszProvider As String,   ' LPCWSTR
    dwMode As UInteger,   ' BCRYPT_QUERY_PROVIDER_MODE
    dwInterface As UInteger,   ' BCRYPT_INTERFACE
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    ppBuffer As IntPtr   ' CRYPT_PROVIDER_REG** optional, out
) As Integer
End Function

' pszProvider : LPCWSTR
' dwMode : BCRYPT_QUERY_PROVIDER_MODE
' dwInterface : BCRYPT_INTERFACE
' pcbBuffer : DWORD* in/out
' ppBuffer : CRYPT_PROVIDER_REG** optional, out
Declare PtrSafe Function BCryptQueryProviderRegistration Lib "bcrypt" ( _
    ByVal pszProvider As LongPtr, _
    ByVal dwMode As Long, _
    ByVal dwInterface As Long, _
    ByRef pcbBuffer As Long, _
    ByVal ppBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BCryptQueryProviderRegistration = ctypes.windll.bcrypt.BCryptQueryProviderRegistration
BCryptQueryProviderRegistration.restype = ctypes.c_int
BCryptQueryProviderRegistration.argtypes = [
    wintypes.LPCWSTR,  # pszProvider : LPCWSTR
    wintypes.DWORD,  # dwMode : BCRYPT_QUERY_PROVIDER_MODE
    wintypes.DWORD,  # dwInterface : BCRYPT_INTERFACE
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
    ctypes.c_void_p,  # ppBuffer : CRYPT_PROVIDER_REG** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptQueryProviderRegistration = Fiddle::Function.new(
  lib['BCryptQueryProviderRegistration'],
  [
    Fiddle::TYPE_VOIDP,  # pszProvider : LPCWSTR
    -Fiddle::TYPE_INT,  # dwMode : BCRYPT_QUERY_PROVIDER_MODE
    -Fiddle::TYPE_INT,  # dwInterface : BCRYPT_INTERFACE
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppBuffer : CRYPT_PROVIDER_REG** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "bcrypt")]
extern "system" {
    fn BCryptQueryProviderRegistration(
        pszProvider: *const u16,  // LPCWSTR
        dwMode: u32,  // BCRYPT_QUERY_PROVIDER_MODE
        dwInterface: u32,  // BCRYPT_INTERFACE
        pcbBuffer: *mut u32,  // DWORD* in/out
        ppBuffer: *mut *mut CRYPT_PROVIDER_REG  // CRYPT_PROVIDER_REG** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptQueryProviderRegistration([MarshalAs(UnmanagedType.LPWStr)] string pszProvider, uint dwMode, uint dwInterface, ref uint pcbBuffer, IntPtr ppBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptQueryProviderRegistration' -Namespace Win32 -PassThru
# $api::BCryptQueryProviderRegistration(pszProvider, dwMode, dwInterface, pcbBuffer, ppBuffer)

#uselib "bcrypt.dll"
#func global BCryptQueryProviderRegistration "BCryptQueryProviderRegistration" sptr, sptr, sptr, sptr, sptr
; BCryptQueryProviderRegistration pszProvider, dwMode, dwInterface, varptr(pcbBuffer), varptr(ppBuffer)   ; 戻り値は stat
; pszProvider : LPCWSTR -> "sptr"
; dwMode : BCRYPT_QUERY_PROVIDER_MODE -> "sptr"
; dwInterface : BCRYPT_INTERFACE -> "sptr"
; pcbBuffer : DWORD* in/out -> "sptr"
; ppBuffer : CRYPT_PROVIDER_REG** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "bcrypt.dll"
#cfunc global BCryptQueryProviderRegistration "BCryptQueryProviderRegistration" wstr, int, int, var, var
; res = BCryptQueryProviderRegistration(pszProvider, dwMode, dwInterface, pcbBuffer, ppBuffer)
; pszProvider : LPCWSTR -> "wstr"
; dwMode : BCRYPT_QUERY_PROVIDER_MODE -> "int"
; dwInterface : BCRYPT_INTERFACE -> "int"
; pcbBuffer : DWORD* in/out -> "var"
; ppBuffer : CRYPT_PROVIDER_REG** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll"
#cfunc global BCryptQueryProviderRegistration "BCryptQueryProviderRegistration" wstr, int, int, sptr, sptr
; res = BCryptQueryProviderRegistration(pszProvider, dwMode, dwInterface, varptr(pcbBuffer), varptr(ppBuffer))
; pszProvider : LPCWSTR -> "wstr"
; dwMode : BCRYPT_QUERY_PROVIDER_MODE -> "int"
; dwInterface : BCRYPT_INTERFACE -> "int"
; pcbBuffer : DWORD* in/out -> "sptr"
; ppBuffer : CRYPT_PROVIDER_REG** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。