ホーム › Security.Cryptography › BCryptEnumContextFunctions

BCryptEnumContextFunctions

関数

CNGコンテキストの指定インターフェイスの暗号機能を列挙する。

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

シグネチャ

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

NTSTATUS BCryptEnumContextFunctions(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    BCRYPT_INTERFACE dwInterface,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_FUNCTIONS** 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	秘密合意 (secret agreement) 関数を取得します。
BCRYPT_SIGNATURE_INTERFACE	署名関数を取得します。
NCRYPT_KEY_STORAGE_INTERFACE	キーストレージ関数を取得します。
NCRYPT_SCHANNEL_INTERFACE	Schannel 関数を取得します。

pcbBuffer

DWORD*

inout

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

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

ppBuffer

CRYPT_CONTEXT_FUNCTIONS**

outoptional

この関数によって取得されるコンテキスト関数のセットを受け取る CRYPT_CONTEXT_FUNCTIONS 構造体へのポインターのアドレスです。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)

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

例

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

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

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

NTSTATUS EnumContextFunctions()
{
    NTSTATUS status;
    ULONG uSize = 0;
    PCRYPT_CONTEXTS pContexts = NULL;
    
    // Get the contexts for the local machine. 
    // CNG will allocate the memory for us.
    status = BCryptEnumContexts(CRYPT_LOCAL, &uSize, &pContexts);
    if(NT_SUCCESS(status))
    {
        // Enumerate the context identifiers.
        for(ULONG uContextIndex = 0; 
            uContextIndex < pContexts->cContexts; 
            uContextIndex++)
        {
            wprintf(L"Context functions for %s:\n", 
                pContexts->rgpszContexts[uContextIndex]);

            // Get the functions for this context.
            // CNG will allocate the memory for us.
            PCRYPT_CONTEXT_FUNCTIONS pContextFunctions = NULL;
            status = BCryptEnumContextFunctions(
                CRYPT_LOCAL, 
                pContexts->rgpszContexts[uContextIndex], 
                NCRYPT_SCHANNEL_INTERFACE, 
                &uSize, 
                &pContextFunctions);
            if(NT_SUCCESS(status))
            {
                // Enumerate the functions.
                for(ULONG i = 0; 
                    i < pContextFunctions->cFunctions; 
                    i++)
                {
                    wprintf(L"\t%s\n", 
                        pContextFunctions->rgpszFunctions[i]);
                }

                // 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 BCryptEnumContextFunctions(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    BCRYPT_INTERFACE dwInterface,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_FUNCTIONS** ppBuffer   // optional
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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