ホーム › Security.Cryptography › BCryptEnumAlgorithms

BCryptEnumAlgorithms

関数

指定操作に対応するCNGアルゴリズムの一覧を列挙する。

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

シグネチャ

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

NTSTATUS BCryptEnumAlgorithms(
    BCRYPT_OPERATION dwAlgOperations,
    DWORD* pAlgCount,
    BCRYPT_ALGORITHM_IDENTIFIER** ppAlgList,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

dwAlgOperations

BCRYPT_OPERATION

列挙に含めるアルゴリズムの操作種別を指定する値です。次の値の 1 つ以上を組み合わせて指定できます。

値	意味
BCRYPT_CIPHER_OPERATION 0x00000001	暗号 (cipher) アルゴリズムを列挙に含めます。
BCRYPT_HASH_OPERATION 0x00000002	ハッシュアルゴリズムを列挙に含めます。
BCRYPT_ASYMMETRIC_ENCRYPTION_OPERATION 0x00000004	非対称暗号化アルゴリズムを列挙に含めます。
BCRYPT_SECRET_AGREEMENT_OPERATION 0x00000008	秘密合意 (secret agreement) アルゴリズムを列挙に含めます。
BCRYPT_SIGNATURE_OPERATION 0x00000010	署名アルゴリズムを列挙に含めます。
BCRYPT_RNG_OPERATION 0x00000020	乱数生成器 (RNG) アルゴリズムを列挙に含めます。
BCRYPT_KEY_DERIVATION_OPERATION 0x00000040	鍵導出アルゴリズムを列挙に含めます。

pAlgCount

DWORD*

out

ppAlgList 配列の要素数を受け取る ULONG 変数へのポインターです。

ppAlgList

BCRYPT_ALGORITHM_IDENTIFIER**

out

登録されているアルゴリズム識別子の配列を受け取る BCRYPT_ALGORITHM_IDENTIFIER 構造体ポインターのアドレスです。このポインターは、不要になった時点で BCryptFreeBuffer 関数に渡す必要があります。

dwFlags

DWORD

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

戻り値の型: NTSTATUS

公式ドキュメント

登録されているアルゴリズム識別子の一覧を取得します。

戻り値

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

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

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

解説(Remarks)

BCryptEnumAlgorithms は、ユーザーモードとカーネルモードのいずれからも呼び出すことができます。カーネルモードの呼び出し元は、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 BCryptEnumAlgorithms(
    BCRYPT_OPERATION dwAlgOperations,
    DWORD* pAlgCount,
    BCRYPT_ALGORITHM_IDENTIFIER** ppAlgList,
    DWORD dwFlags
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptEnumAlgorithms(
    uint dwAlgOperations,   // BCRYPT_OPERATION
    out uint pAlgCount,   // DWORD* out
    IntPtr ppAlgList,   // BCRYPT_ALGORITHM_IDENTIFIER** out
    uint dwFlags   // DWORD
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptEnumAlgorithms(
    dwAlgOperations As UInteger,   ' BCRYPT_OPERATION
    <Out> ByRef pAlgCount As UInteger,   ' DWORD* out
    ppAlgList As IntPtr,   ' BCRYPT_ALGORITHM_IDENTIFIER** out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' dwAlgOperations : BCRYPT_OPERATION
' pAlgCount : DWORD* out
' ppAlgList : BCRYPT_ALGORITHM_IDENTIFIER** out
' dwFlags : DWORD
Declare PtrSafe Function BCryptEnumAlgorithms Lib "bcrypt" ( _
    ByVal dwAlgOperations As Long, _
    ByRef pAlgCount As Long, _
    ByVal ppAlgList 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

BCryptEnumAlgorithms = ctypes.windll.bcrypt.BCryptEnumAlgorithms
BCryptEnumAlgorithms.restype = ctypes.c_int
BCryptEnumAlgorithms.argtypes = [
    wintypes.DWORD,  # dwAlgOperations : BCRYPT_OPERATION
    ctypes.POINTER(wintypes.DWORD),  # pAlgCount : DWORD* out
    ctypes.c_void_p,  # ppAlgList : BCRYPT_ALGORITHM_IDENTIFIER** out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptEnumAlgorithms = Fiddle::Function.new(
  lib['BCryptEnumAlgorithms'],
  [
    -Fiddle::TYPE_INT,  # dwAlgOperations : BCRYPT_OPERATION
    Fiddle::TYPE_VOIDP,  # pAlgCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppAlgList : BCRYPT_ALGORITHM_IDENTIFIER** out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "bcrypt")]
extern "system" {
    fn BCryptEnumAlgorithms(
        dwAlgOperations: u32,  // BCRYPT_OPERATION
        pAlgCount: *mut u32,  // DWORD* out
        ppAlgList: *mut *mut BCRYPT_ALGORITHM_IDENTIFIER,  // BCRYPT_ALGORITHM_IDENTIFIER** out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptEnumAlgorithms(uint dwAlgOperations, out uint pAlgCount, IntPtr ppAlgList, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptEnumAlgorithms' -Namespace Win32 -PassThru
# $api::BCryptEnumAlgorithms(dwAlgOperations, pAlgCount, ppAlgList, dwFlags)

#uselib "bcrypt.dll"
#func global BCryptEnumAlgorithms "BCryptEnumAlgorithms" sptr, sptr, sptr, sptr
; BCryptEnumAlgorithms dwAlgOperations, varptr(pAlgCount), varptr(ppAlgList), dwFlags   ; 戻り値は stat
; dwAlgOperations : BCRYPT_OPERATION -> "sptr"
; pAlgCount : DWORD* out -> "sptr"
; ppAlgList : BCRYPT_ALGORITHM_IDENTIFIER** out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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