BCryptOpenAlgorithmProvider
関数シグネチャ
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptOpenAlgorithmProvider(
BCRYPT_ALG_HANDLE* phAlgorithm,
LPCWSTR pszAlgId,
LPCWSTR pszImplementation, // optional
BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| phAlgorithm | BCRYPT_ALG_HANDLE* | out | CNG プロバイダーのハンドルを受け取る BCRYPT_ALG_HANDLE 変数へのポインターです。このハンドルの使用が終わったら、BCryptCloseAlgorithmProvider 関数に渡して解放してください。 | ||||||||
| pszAlgId | LPCWSTR | in | 要求する暗号アルゴリズムを識別する、null 終端の Unicode 文字列へのポインターです。標準の CNG Algorithm Identifiers のいずれか、または登録済みの別のアルゴリズムの識別子を指定できます。 | ||||||||
| pszImplementation | LPCWSTR | inoptional | 読み込む特定のプロバイダーを識別する、null 終端の Unicode 文字列へのポインターです。これは暗号プリミティブ プロバイダーの登録済みエイリアスです。このパラメーターは省略可能で、必要なければ メモ
pszImplementation パラメーターの値が Windows Server 2008 および Windows Vista: CNG は Microsoft CNG プロバイダーへのフォールバックを試みます。 定義済みのプロバイダー名は次のとおりです。
| ||||||||
| dwFlags | BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS | in | 関数の動作を変更するフラグです。0、または次の値のうち 1 つ以上の組み合わせを指定できます。
|
戻り値の型: NTSTATUS
公式ドキュメント
CNG プロバイダーを読み込み、初期化します。
戻り値
関数の成功または失敗を示すステータス コードを返します。
返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。
| 戻り値コード | 説明 |
|---|---|
| STATUS_SUCCESS | 関数は成功しました。 |
| STATUS_NOT_FOUND | 指定されたアルゴリズム ID に対するプロバイダーが見つかりませんでした。 |
| STATUS_INVALID_PARAMETER | 指定されたパラメーターのいずれかが無効です。 |
| STATUS_NO_MEMORY | メモリ割り当てエラーが発生しました。 |
| STATUS_NOT_SUPPORTED | 指定されたフラグのいずれかが、指定されたアルゴリズム ID でサポートされていません。 |
解説(Remarks)
アルゴリズム プロバイダーの検索、読み込み、初期化に必要な操作の数と種類のため、BCryptOpenAlgorithmProvider 関数は比較的時間のかかる関数です。そのため、可能な場合は CNG Algorithm Pseudo-handles を使用するか、複数回使用するアルゴリズム プロバイダー ハンドルをキャッシュして、アルゴリズム プロバイダーを繰り返し開いたり閉じたりしないことをお勧めします。
BCryptOpenAlgorithmProvider は、ユーザー モードまたはカーネル モードのいずれからでも呼び出せます。カーネル モードの呼び出し元は PASSIVE_LEVEL IRQL で実行されている必要があります。
この関数をカーネル モードで呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネル モードで呼び出すには、Ksecdd.lib を使用します。
Windows 10 以降、CNG は暗号構成へのすべての更新を自動的に処理しなくなりました。新しい既定プロバイダーの追加やアルゴリズム プロバイダーの優先順位の変更などの一部の変更には、再起動が必要になる場合があります。このため、新しく構成したプロバイダーで BCryptOpenAlgorithmProvider を呼び出す前に、再起動してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptOpenAlgorithmProvider(
BCRYPT_ALG_HANDLE* phAlgorithm,
LPCWSTR pszAlgId,
LPCWSTR pszImplementation, // optional
BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS dwFlags
);[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptOpenAlgorithmProvider(
IntPtr phAlgorithm, // BCRYPT_ALG_HANDLE* out
[MarshalAs(UnmanagedType.LPWStr)] string pszAlgId, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string pszImplementation, // LPCWSTR optional
uint dwFlags // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
);<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptOpenAlgorithmProvider(
phAlgorithm As IntPtr, ' BCRYPT_ALG_HANDLE* out
<MarshalAs(UnmanagedType.LPWStr)> pszAlgId As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> pszImplementation As String, ' LPCWSTR optional
dwFlags As UInteger ' BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
) As Integer
End Function' phAlgorithm : BCRYPT_ALG_HANDLE* out
' pszAlgId : LPCWSTR
' pszImplementation : LPCWSTR optional
' dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
Declare PtrSafe Function BCryptOpenAlgorithmProvider Lib "bcrypt" ( _
ByVal phAlgorithm As LongPtr, _
ByVal pszAlgId As LongPtr, _
ByVal pszImplementation 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
BCryptOpenAlgorithmProvider = ctypes.windll.bcrypt.BCryptOpenAlgorithmProvider
BCryptOpenAlgorithmProvider.restype = ctypes.c_int
BCryptOpenAlgorithmProvider.argtypes = [
ctypes.c_void_p, # phAlgorithm : BCRYPT_ALG_HANDLE* out
wintypes.LPCWSTR, # pszAlgId : LPCWSTR
wintypes.LPCWSTR, # pszImplementation : LPCWSTR optional
wintypes.DWORD, # dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('bcrypt.dll')
BCryptOpenAlgorithmProvider = Fiddle::Function.new(
lib['BCryptOpenAlgorithmProvider'],
[
Fiddle::TYPE_VOIDP, # phAlgorithm : BCRYPT_ALG_HANDLE* out
Fiddle::TYPE_VOIDP, # pszAlgId : LPCWSTR
Fiddle::TYPE_VOIDP, # pszImplementation : LPCWSTR optional
-Fiddle::TYPE_INT, # dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
],
Fiddle::TYPE_INT)#[link(name = "bcrypt")]
extern "system" {
fn BCryptOpenAlgorithmProvider(
phAlgorithm: *mut *mut core::ffi::c_void, // BCRYPT_ALG_HANDLE* out
pszAlgId: *const u16, // LPCWSTR
pszImplementation: *const u16, // LPCWSTR optional
dwFlags: u32 // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptOpenAlgorithmProvider(IntPtr phAlgorithm, [MarshalAs(UnmanagedType.LPWStr)] string pszAlgId, [MarshalAs(UnmanagedType.LPWStr)] string pszImplementation, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptOpenAlgorithmProvider' -Namespace Win32 -PassThru
# $api::BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)#uselib "bcrypt.dll"
#func global BCryptOpenAlgorithmProvider "BCryptOpenAlgorithmProvider" sptr, sptr, sptr, sptr
; BCryptOpenAlgorithmProvider phAlgorithm, pszAlgId, pszImplementation, dwFlags ; 戻り値は stat
; phAlgorithm : BCRYPT_ALG_HANDLE* out -> "sptr"
; pszAlgId : LPCWSTR -> "sptr"
; pszImplementation : LPCWSTR optional -> "sptr"
; dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "bcrypt.dll"
#cfunc global BCryptOpenAlgorithmProvider "BCryptOpenAlgorithmProvider" sptr, wstr, wstr, int
; res = BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
; phAlgorithm : BCRYPT_ALG_HANDLE* out -> "sptr"
; pszAlgId : LPCWSTR -> "wstr"
; pszImplementation : LPCWSTR optional -> "wstr"
; dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> "int"; NTSTATUS BCryptOpenAlgorithmProvider(BCRYPT_ALG_HANDLE* phAlgorithm, LPCWSTR pszAlgId, LPCWSTR pszImplementation, BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptOpenAlgorithmProvider "BCryptOpenAlgorithmProvider" intptr, wstr, wstr, int
; res = BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
; phAlgorithm : BCRYPT_ALG_HANDLE* out -> "intptr"
; pszAlgId : LPCWSTR -> "wstr"
; pszImplementation : LPCWSTR optional -> "wstr"
; dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
procBCryptOpenAlgorithmProvider = bcrypt.NewProc("BCryptOpenAlgorithmProvider")
)
// phAlgorithm (BCRYPT_ALG_HANDLE* out), pszAlgId (LPCWSTR), pszImplementation (LPCWSTR optional), dwFlags (BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS)
r1, _, err := procBCryptOpenAlgorithmProvider.Call(
uintptr(phAlgorithm),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszAlgId))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszImplementation))),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // NTSTATUSfunction BCryptOpenAlgorithmProvider(
phAlgorithm: Pointer; // BCRYPT_ALG_HANDLE* out
pszAlgId: PWideChar; // LPCWSTR
pszImplementation: PWideChar; // LPCWSTR optional
dwFlags: DWORD // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptOpenAlgorithmProvider';result := DllCall("bcrypt\BCryptOpenAlgorithmProvider"
, "Ptr", phAlgorithm ; BCRYPT_ALG_HANDLE* out
, "WStr", pszAlgId ; LPCWSTR
, "WStr", pszImplementation ; LPCWSTR optional
, "UInt", dwFlags ; BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
, "Int") ; return: NTSTATUS●BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags) = DLL("bcrypt.dll", "int BCryptOpenAlgorithmProvider(void*, char*, char*, dword)")
# 呼び出し: BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
# phAlgorithm : BCRYPT_ALG_HANDLE* out -> "void*"
# pszAlgId : LPCWSTR -> "char*"
# pszImplementation : LPCWSTR optional -> "char*"
# dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "bcrypt" fn BCryptOpenAlgorithmProvider(
phAlgorithm: ?*anyopaque, // BCRYPT_ALG_HANDLE* out
pszAlgId: [*c]const u16, // LPCWSTR
pszImplementation: [*c]const u16, // LPCWSTR optional
dwFlags: u32 // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
) callconv(std.os.windows.WINAPI) i32;proc BCryptOpenAlgorithmProvider(
phAlgorithm: pointer, # BCRYPT_ALG_HANDLE* out
pszAlgId: WideCString, # LPCWSTR
pszImplementation: WideCString, # LPCWSTR optional
dwFlags: uint32 # BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
): int32 {.importc: "BCryptOpenAlgorithmProvider", stdcall, dynlib: "bcrypt.dll".}pragma(lib, "bcrypt");
extern(Windows)
int BCryptOpenAlgorithmProvider(
void* phAlgorithm, // BCRYPT_ALG_HANDLE* out
const(wchar)* pszAlgId, // LPCWSTR
const(wchar)* pszImplementation, // LPCWSTR optional
uint dwFlags // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
);ccall((:BCryptOpenAlgorithmProvider, "bcrypt.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring, Cwstring, UInt32),
phAlgorithm, pszAlgId, pszImplementation, dwFlags)
# phAlgorithm : BCRYPT_ALG_HANDLE* out -> Ptr{Cvoid}
# pszAlgId : LPCWSTR -> Cwstring
# pszImplementation : LPCWSTR optional -> Cwstring
# dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptOpenAlgorithmProvider(
void* phAlgorithm,
const uint16_t* pszAlgId,
const uint16_t* pszImplementation,
uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
-- phAlgorithm : BCRYPT_ALG_HANDLE* out
-- pszAlgId : LPCWSTR
-- pszImplementation : LPCWSTR optional
-- dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptOpenAlgorithmProvider = lib.func('__stdcall', 'BCryptOpenAlgorithmProvider', 'int32_t', ['void *', 'str16', 'str16', 'uint32_t']);
// BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
// phAlgorithm : BCRYPT_ALG_HANDLE* out -> 'void *'
// pszAlgId : LPCWSTR -> 'str16'
// pszImplementation : LPCWSTR optional -> 'str16'
// dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("bcrypt.dll", {
BCryptOpenAlgorithmProvider: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags)
// phAlgorithm : BCRYPT_ALG_HANDLE* out -> "pointer"
// pszAlgId : LPCWSTR -> "buffer"
// pszImplementation : LPCWSTR optional -> "buffer"
// dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptOpenAlgorithmProvider(
void* phAlgorithm,
const uint16_t* pszAlgId,
const uint16_t* pszImplementation,
uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptOpenAlgorithmProvider(phAlgorithm, pszAlgId, pszImplementation, dwFlags);
// phAlgorithm : BCRYPT_ALG_HANDLE* out
// pszAlgId : LPCWSTR
// pszImplementation : LPCWSTR optional
// dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Bcrypt extends StdCallLibrary {
Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
int BCryptOpenAlgorithmProvider(
Pointer phAlgorithm, // BCRYPT_ALG_HANDLE* out
WString pszAlgId, // LPCWSTR
WString pszImplementation, // LPCWSTR optional
int dwFlags // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
);
}@[Link("bcrypt")]
lib Libbcrypt
fun BCryptOpenAlgorithmProvider = BCryptOpenAlgorithmProvider(
phAlgorithm : Void*, # BCRYPT_ALG_HANDLE* out
pszAlgId : UInt16*, # LPCWSTR
pszImplementation : UInt16*, # LPCWSTR optional
dwFlags : UInt32 # BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef BCryptOpenAlgorithmProviderNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef BCryptOpenAlgorithmProviderDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final BCryptOpenAlgorithmProvider = DynamicLibrary.open('bcrypt.dll')
.lookupFunction<BCryptOpenAlgorithmProviderNative, BCryptOpenAlgorithmProviderDart>('BCryptOpenAlgorithmProvider');
// phAlgorithm : BCRYPT_ALG_HANDLE* out -> Pointer<Void>
// pszAlgId : LPCWSTR -> Pointer<Utf16>
// pszImplementation : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function BCryptOpenAlgorithmProvider(
phAlgorithm: Pointer; // BCRYPT_ALG_HANDLE* out
pszAlgId: PWideChar; // LPCWSTR
pszImplementation: PWideChar; // LPCWSTR optional
dwFlags: DWORD // BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptOpenAlgorithmProvider';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "BCryptOpenAlgorithmProvider"
c_BCryptOpenAlgorithmProvider :: Ptr () -> CWString -> CWString -> Word32 -> IO Int32
-- phAlgorithm : BCRYPT_ALG_HANDLE* out -> Ptr ()
-- pszAlgId : LPCWSTR -> CWString
-- pszImplementation : LPCWSTR optional -> CWString
-- dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let bcryptopenalgorithmprovider =
foreign "BCryptOpenAlgorithmProvider"
((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* phAlgorithm : BCRYPT_ALG_HANDLE* out -> (ptr void) *)
(* pszAlgId : LPCWSTR -> (ptr uint16_t) *)
(* pszImplementation : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)
(cffi:defcfun ("BCryptOpenAlgorithmProvider" bcrypt-open-algorithm-provider :convention :stdcall) :int32
(ph-algorithm :pointer) ; BCRYPT_ALG_HANDLE* out
(psz-alg-id (:string :encoding :utf-16le)) ; LPCWSTR
(psz-implementation (:string :encoding :utf-16le)) ; LPCWSTR optional
(dw-flags :uint32)) ; BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $BCryptOpenAlgorithmProvider = Win32::API::More->new('bcrypt',
'int BCryptOpenAlgorithmProvider(HANDLE phAlgorithm, LPCWSTR pszAlgId, LPCWSTR pszImplementation, DWORD dwFlags)');
# my $ret = $BCryptOpenAlgorithmProvider->Call($phAlgorithm, $pszAlgId, $pszImplementation, $dwFlags);
# phAlgorithm : BCRYPT_ALG_HANDLE* out -> HANDLE
# pszAlgId : LPCWSTR -> LPCWSTR
# pszImplementation : LPCWSTR optional -> LPCWSTR
# dwFlags : BCRYPT_OPEN_ALGORITHM_PROVIDER_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。