ホーム › Security.Cryptography › BCryptEnumProviders

BCryptEnumProviders

関数

指定アルゴリズムを実装するCNGプロバイダーを列挙する。

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

シグネチャ

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

NTSTATUS BCryptEnumProviders(
    LPCWSTR pszAlgId,
    DWORD* pImplCount,
    BCRYPT_PROVIDER_NAME** ppImplList,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
pszAlgId	LPCWSTR	in	プロバイダーを取得する対象のアルゴリズムを識別する、null で終わる Unicode 文字列へのポインター。事前定義された CNG Algorithm Identifiers のいずれか、または別のアルゴリズム識別子を指定できます。
pImplCount	DWORD*	out	ppImplList 配列の要素数を受け取る ULONG 変数へのポインター。
ppImplList	BCRYPT_PROVIDER_NAME**	out	指定したアルゴリズムをサポートするプロバイダーのコレクションを受け取る BCRYPT_PROVIDER_NAME 構造体の配列のアドレス。この配列の要素数は pImplCount パラメーターが受け取ります。このメモリは不要になった時点で、このポインターを BCryptFreeBuffer 関数に渡して解放する必要があります。
dwFlags	DWORD	in	この関数の動作を変更するフラグのセット。現在定義されているフラグはないため、このパラメーターは 0 にする必要があります。

戻り値の型: NTSTATUS

公式ドキュメント

指定したアルゴリズムをサポートするすべての CNG プロバイダーを取得します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

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

戻り値	説明
STATUS_SUCCESS	関数は成功しました。
STATUS_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
STATUS_NO_MEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

BCryptEnumProviders はユーザーモードまたはカーネルモードのいずれからも呼び出すことができます。カーネルモードの呼び出し元は PASSIVE_LEVEL IRQL で実行されている必要があります。

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

各言語での呼び出し定義

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

NTSTATUS BCryptEnumProviders(
    LPCWSTR pszAlgId,
    DWORD* pImplCount,
    BCRYPT_PROVIDER_NAME** ppImplList,
    DWORD dwFlags
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptEnumProviders(
    [MarshalAs(UnmanagedType.LPWStr)] string pszAlgId,   // LPCWSTR
    out uint pImplCount,   // DWORD* out
    IntPtr ppImplList,   // BCRYPT_PROVIDER_NAME** out
    uint dwFlags   // DWORD
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptEnumProviders(
    <MarshalAs(UnmanagedType.LPWStr)> pszAlgId As String,   ' LPCWSTR
    <Out> ByRef pImplCount As UInteger,   ' DWORD* out
    ppImplList As IntPtr,   ' BCRYPT_PROVIDER_NAME** out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' pszAlgId : LPCWSTR
' pImplCount : DWORD* out
' ppImplList : BCRYPT_PROVIDER_NAME** out
' dwFlags : DWORD
Declare PtrSafe Function BCryptEnumProviders Lib "bcrypt" ( _
    ByVal pszAlgId As LongPtr, _
    ByRef pImplCount As Long, _
    ByVal ppImplList As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BCryptEnumProviders = ctypes.windll.bcrypt.BCryptEnumProviders
BCryptEnumProviders.restype = ctypes.c_int
BCryptEnumProviders.argtypes = [
    wintypes.LPCWSTR,  # pszAlgId : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # pImplCount : DWORD* out
    ctypes.c_void_p,  # ppImplList : BCRYPT_PROVIDER_NAME** out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptEnumProviders = Fiddle::Function.new(
  lib['BCryptEnumProviders'],
  [
    Fiddle::TYPE_VOIDP,  # pszAlgId : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pImplCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppImplList : BCRYPT_PROVIDER_NAME** out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "bcrypt")]
extern "system" {
    fn BCryptEnumProviders(
        pszAlgId: *const u16,  // LPCWSTR
        pImplCount: *mut u32,  // DWORD* out
        ppImplList: *mut *mut BCRYPT_PROVIDER_NAME,  // BCRYPT_PROVIDER_NAME** out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptEnumProviders([MarshalAs(UnmanagedType.LPWStr)] string pszAlgId, out uint pImplCount, IntPtr ppImplList, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptEnumProviders' -Namespace Win32 -PassThru
# $api::BCryptEnumProviders(pszAlgId, pImplCount, ppImplList, dwFlags)

#uselib "bcrypt.dll"
#func global BCryptEnumProviders "BCryptEnumProviders" sptr, sptr, sptr, sptr
; BCryptEnumProviders pszAlgId, varptr(pImplCount), varptr(ppImplList), dwFlags   ; 戻り値は stat
; pszAlgId : LPCWSTR -> "sptr"
; pImplCount : DWORD* out -> "sptr"
; ppImplList : BCRYPT_PROVIDER_NAME** out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "bcrypt.dll"
#cfunc global BCryptEnumProviders "BCryptEnumProviders" wstr, var, var, int
; res = BCryptEnumProviders(pszAlgId, pImplCount, ppImplList, dwFlags)
; pszAlgId : LPCWSTR -> "wstr"
; pImplCount : DWORD* out -> "var"
; ppImplList : BCRYPT_PROVIDER_NAME** out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll"
#cfunc global BCryptEnumProviders "BCryptEnumProviders" wstr, sptr, sptr, int
; res = BCryptEnumProviders(pszAlgId, varptr(pImplCount), varptr(ppImplList), dwFlags)
; pszAlgId : LPCWSTR -> "wstr"
; pImplCount : DWORD* out -> "sptr"
; ppImplList : BCRYPT_PROVIDER_NAME** out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。