ホーム › Security.Cryptography › BCryptEnumContextFunctionProviders

BCryptEnumContextFunctionProviders

関数

CNGコンテキストの指定機能を提供するプロバイダーを列挙する。

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

シグネチャ

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

NTSTATUS BCryptEnumContextFunctionProviders(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    BCRYPT_INTERFACE dwInterface,
    LPCWSTR pszFunction,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_FUNCTION_PROVIDERS** ppBuffer   // optional
);

パラメーター

名前

型

方向

説明

dwTable

BCRYPT_TABLE

コンテキスト関数プロバイダーを取得する構成テーブルを識別します。次のいずれかの値を指定できます。

値	意味
CRYPT_LOCAL	ローカルマシンの構成テーブルからコンテキスト関数を取得します。
CRYPT_DOMAIN	この値は使用できません。

pszContext

LPCWSTR

関数プロバイダーを列挙する対象のコンテキストの識別子を含む、null で終わる Unicode 文字列へのポインター。

dwInterface

BCRYPT_INTERFACE

関数プロバイダーを取得する対象の暗号化インターフェイスを識別します。次のいずれかの値を指定できます。

値	意味
BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE	非対称暗号化関数のプロバイダーを取得します。
BCRYPT_CIPHER_INTERFACE	暗号 (cipher) 関数のプロバイダーを取得します。
BCRYPT_HASH_INTERFACE	ハッシュ関数のプロバイダーを取得します。
BCRYPT_RNG_INTERFACE	乱数ジェネレーター関数のプロバイダーを取得します。
BCRYPT_SECRET_AGREEMENT_INTERFACE	シークレットアグリーメント関数のプロバイダーを取得します。
BCRYPT_SIGNATURE_INTERFACE	署名関数のプロバイダーを取得します。
NCRYPT_KEY_STORAGE_INTERFACE	キーストレージ関数のプロバイダーを取得します。
NCRYPT_SCHANNEL_INTERFACE	Schannel 関数のプロバイダーを取得します。

pszFunction

LPCWSTR

プロバイダーを列挙する対象の関数の識別子を含む、null で終わる Unicode 文字列へのポインター。

pcbBuffer

DWORD*

inout

ULONG 変数のアドレス。呼び出し時には、ppBuffer が指すバッファーのサイズ (バイト単位) を格納します。このサイズがコンテキスト識別子のセットを保持するのに十分でない場合、この関数は STATUS_BUFFER_TOO_SMALL で失敗します。

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

ppBuffer

CRYPT_CONTEXT_FUNCTION_PROVIDERS**

outoptional

CRYPT_CONTEXT_FUNCTION_PROVIDERS 構造体へのポインターのアドレス。この関数が取得したコンテキスト関数プロバイダーのセットを受け取ります。pcbBuffer パラメーターが指す値には、このバッファーのサイズが格納されます。

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

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

戻り値の型: NTSTATUS

公式ドキュメント

指定された構成テーブル内のコンテキストについて、暗号化関数のプロバイダーを取得します。

戻り値

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

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

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

解説(Remarks)

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

例

次の例は、BCryptEnumContextFunctionProviders 関数を使用して、ローカルマシンの構成テーブル内のすべてのコンテキストについて、すべてのキーストレージ関数のプロバイダーを列挙する方法を示しています。

#include <windows.h>
#include <stdio.h>
#include <ntstatus.h>
#include <Bcrypt.h>
#pragma comment(lib, "Bcrypt.lib")

#ifndef NT_SUCCESS
#define NT_SUCCESS(Status) ((NTSTATUS)(Status) >= 0)
#endif

NTSTATUS EnumContextFunctionProviders()
{
    NTSTATUS status;
    ULONG uSize = 0;
    ULONG uTable = CRYPT_LOCAL;
    PCRYPT_CONTEXTS pContexts = NULL;
    
    // Get the contexts for the local machine. 
    // CNG will allocate the memory for us.
    status = BCryptEnumContexts(uTable, &uSize, &pContexts);
    if(NT_SUCCESS(status))
    {
        // Enumerate the context identifiers.
        for(ULONG a = 0; 
            a < pContexts->cContexts; 
            a++)
        {
            ULONG uInterface = NCRYPT_SCHANNEL_INTERFACE;

            wprintf(L"Context functions for %s:\n", 
                pContexts->rgpszContexts[a]);

            // Get the functions for this context.
            // CNG will allocate the memory for us.
            PCRYPT_CONTEXT_FUNCTIONS pContextFunctions = NULL;
            status = BCryptEnumContextFunctions(
                uTable, 
                pContexts->rgpszContexts[a], 
                uInterface, 
                &uSize, 
                &pContextFunctions);
            if(NT_SUCCESS(status))
            {
                // Enumerate the functions.
                for(ULONG b = 0; 
                    b < pContextFunctions->cFunctions; 
                    b++)
                {
                    wprintf(L"\tFunction providers for %s:\n", 
                        pContextFunctions->rgpszFunctions[b]);

                    // Get the providers for this function.
                    PCRYPT_CONTEXT_FUNCTION_PROVIDERS pProviders;
                    pProviders = NULL;
                    status = BCryptEnumContextFunctionProviders(
                        uTable, 
                        pContexts->rgpszContexts[a], 
                        uInterface, 
                        pContextFunctions->rgpszFunctions[b],
                        &uSize, 
                        &pProviders);
                    if(NT_SUCCESS(status))
                    {
                        for(ULONG c = 0; 
                            c < pProviders->cProviders; 
                            c++)
                        {
                            wprintf(L"\t\t%s\n", 
                                pProviders->rgpszProviders[c]);
                        }
                    }
                    else if(STATUS_NOT_FOUND == status)
                    {
                        wprintf(L"\t\tNone found.\n");
                    }
                }

                // Free the context functions buffer.
                BCryptFreeBuffer(pContextFunctions);
            }
        }

        // Free the contexts buffer.
        BCryptFreeBuffer(pContexts);
    }

    return status;
}

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

各言語での呼び出し定義

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

NTSTATUS BCryptEnumContextFunctionProviders(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    BCRYPT_INTERFACE dwInterface,
    LPCWSTR pszFunction,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_FUNCTION_PROVIDERS** ppBuffer   // optional
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptEnumContextFunctionProviders(
    uint dwTable,   // BCRYPT_TABLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszContext,   // LPCWSTR
    uint dwInterface,   // BCRYPT_INTERFACE
    [MarshalAs(UnmanagedType.LPWStr)] string pszFunction,   // LPCWSTR
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr ppBuffer   // CRYPT_CONTEXT_FUNCTION_PROVIDERS** optional, out
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptEnumContextFunctionProviders(
    dwTable As UInteger,   ' BCRYPT_TABLE
    <MarshalAs(UnmanagedType.LPWStr)> pszContext As String,   ' LPCWSTR
    dwInterface As UInteger,   ' BCRYPT_INTERFACE
    <MarshalAs(UnmanagedType.LPWStr)> pszFunction As String,   ' LPCWSTR
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    ppBuffer As IntPtr   ' CRYPT_CONTEXT_FUNCTION_PROVIDERS** optional, out
) As Integer
End Function

' dwTable : BCRYPT_TABLE
' pszContext : LPCWSTR
' dwInterface : BCRYPT_INTERFACE
' pszFunction : LPCWSTR
' pcbBuffer : DWORD* in/out
' ppBuffer : CRYPT_CONTEXT_FUNCTION_PROVIDERS** optional, out
Declare PtrSafe Function BCryptEnumContextFunctionProviders Lib "bcrypt" ( _
    ByVal dwTable As Long, _
    ByVal pszContext As LongPtr, _
    ByVal dwInterface As Long, _
    ByVal pszFunction As LongPtr, _
    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

BCryptEnumContextFunctionProviders = ctypes.windll.bcrypt.BCryptEnumContextFunctionProviders
BCryptEnumContextFunctionProviders.restype = ctypes.c_int
BCryptEnumContextFunctionProviders.argtypes = [
    wintypes.DWORD,  # dwTable : BCRYPT_TABLE
    wintypes.LPCWSTR,  # pszContext : LPCWSTR
    wintypes.DWORD,  # dwInterface : BCRYPT_INTERFACE
    wintypes.LPCWSTR,  # pszFunction : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
    ctypes.c_void_p,  # ppBuffer : CRYPT_CONTEXT_FUNCTION_PROVIDERS** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptEnumContextFunctionProviders = Fiddle::Function.new(
  lib['BCryptEnumContextFunctionProviders'],
  [
    -Fiddle::TYPE_INT,  # dwTable : BCRYPT_TABLE
    Fiddle::TYPE_VOIDP,  # pszContext : LPCWSTR
    -Fiddle::TYPE_INT,  # dwInterface : BCRYPT_INTERFACE
    Fiddle::TYPE_VOIDP,  # pszFunction : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppBuffer : CRYPT_CONTEXT_FUNCTION_PROVIDERS** optional, out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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