ホーム › Security.Cryptography › BCryptDeriveKeyCapi
BCryptDeriveKeyCapi
関数CAPI互換方式でハッシュから鍵データを導出する。
シグネチャ
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptDeriveKeyCapi(
BCRYPT_HASH_HANDLE hHash,
BCRYPT_ALG_HANDLE hTargetAlg, // optional
BYTE* pbDerivedKey,
DWORD cbDerivedKey,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hHash | BCRYPT_HASH_HANDLE | in | ハッシュオブジェクトのハンドルです。このハンドルは BCryptCreateHash 関数を呼び出して取得します。ハンドルの使用を終えたら、BCryptDestroyHash 関数を呼び出して解放する必要があります。 |
| hTargetAlg | BCRYPT_ALG_HANDLE | inoptional | アルゴリズムオブジェクトのハンドルです。これには、CryptDeriveKey 関数と互換性のある ALG_ID 値を指定できます。 Note CAPI とキー拡張の制限により、512 ビットを超える出力を生成するハッシュアルゴリズムは使用できません。
|
| pbDerivedKey | BYTE* | out | 導出されたキーを受け取るバッファへのポインターです。 |
| cbDerivedKey | DWORD | in | pbDerivedKey パラメーターが指す導出キーのサイズ(文字数)です。 |
| dwFlags | DWORD | in | このパラメーターは予約済みであり、0 に設定する必要があります。 |
戻り値の型: NTSTATUS
公式ドキュメント
ハッシュ値からキーを導出します。
戻り値
関数の成功または失敗を示すステータスコードを返します。
返される可能性のあるコードには、次のものが含まれます(ただしこれらに限定されません)。
| Return code | Description |
|---|---|
| 関数は成功しました。 | |
| hHash または hTargetAlg パラメーターのハンドルが無効です。 | |
| cbDerivedKey パラメーターの値が、ハッシュ関数の出力サイズの 2 倍を超えています。 | |
| メモリの割り当てに失敗しました。 |
解説(Remarks)
この関数は、CAPI の CryptDeriveKey 関数の PK ソルト機能をサポートしていません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptDeriveKeyCapi(
BCRYPT_HASH_HANDLE hHash,
BCRYPT_ALG_HANDLE hTargetAlg, // optional
BYTE* pbDerivedKey,
DWORD cbDerivedKey,
DWORD dwFlags
);[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptDeriveKeyCapi(
IntPtr hHash, // BCRYPT_HASH_HANDLE
IntPtr hTargetAlg, // BCRYPT_ALG_HANDLE optional
IntPtr pbDerivedKey, // BYTE* out
uint cbDerivedKey, // DWORD
uint dwFlags // DWORD
);<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptDeriveKeyCapi(
hHash As IntPtr, ' BCRYPT_HASH_HANDLE
hTargetAlg As IntPtr, ' BCRYPT_ALG_HANDLE optional
pbDerivedKey As IntPtr, ' BYTE* out
cbDerivedKey As UInteger, ' DWORD
dwFlags As UInteger ' DWORD
) As Integer
End Function' hHash : BCRYPT_HASH_HANDLE
' hTargetAlg : BCRYPT_ALG_HANDLE optional
' pbDerivedKey : BYTE* out
' cbDerivedKey : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptDeriveKeyCapi Lib "bcrypt" ( _
ByVal hHash As LongPtr, _
ByVal hTargetAlg As LongPtr, _
ByVal pbDerivedKey As LongPtr, _
ByVal cbDerivedKey As Long, _
ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
BCryptDeriveKeyCapi = ctypes.windll.bcrypt.BCryptDeriveKeyCapi
BCryptDeriveKeyCapi.restype = ctypes.c_int
BCryptDeriveKeyCapi.argtypes = [
wintypes.HANDLE, # hHash : BCRYPT_HASH_HANDLE
wintypes.HANDLE, # hTargetAlg : BCRYPT_ALG_HANDLE optional
ctypes.POINTER(ctypes.c_ubyte), # pbDerivedKey : BYTE* out
wintypes.DWORD, # cbDerivedKey : DWORD
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('bcrypt.dll')
BCryptDeriveKeyCapi = Fiddle::Function.new(
lib['BCryptDeriveKeyCapi'],
[
Fiddle::TYPE_VOIDP, # hHash : BCRYPT_HASH_HANDLE
Fiddle::TYPE_VOIDP, # hTargetAlg : BCRYPT_ALG_HANDLE optional
Fiddle::TYPE_VOIDP, # pbDerivedKey : BYTE* out
-Fiddle::TYPE_INT, # cbDerivedKey : DWORD
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "bcrypt")]
extern "system" {
fn BCryptDeriveKeyCapi(
hHash: *mut core::ffi::c_void, // BCRYPT_HASH_HANDLE
hTargetAlg: *mut core::ffi::c_void, // BCRYPT_ALG_HANDLE optional
pbDerivedKey: *mut u8, // BYTE* out
cbDerivedKey: u32, // DWORD
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptDeriveKeyCapi(IntPtr hHash, IntPtr hTargetAlg, IntPtr pbDerivedKey, uint cbDerivedKey, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptDeriveKeyCapi' -Namespace Win32 -PassThru
# $api::BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)#uselib "bcrypt.dll"
#func global BCryptDeriveKeyCapi "BCryptDeriveKeyCapi" sptr, sptr, sptr, sptr, sptr
; BCryptDeriveKeyCapi hHash, hTargetAlg, varptr(pbDerivedKey), cbDerivedKey, dwFlags ; 戻り値は stat
; hHash : BCRYPT_HASH_HANDLE -> "sptr"
; hTargetAlg : BCRYPT_ALG_HANDLE optional -> "sptr"
; pbDerivedKey : BYTE* out -> "sptr"
; cbDerivedKey : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "bcrypt.dll" #cfunc global BCryptDeriveKeyCapi "BCryptDeriveKeyCapi" sptr, sptr, var, int, int ; res = BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags) ; hHash : BCRYPT_HASH_HANDLE -> "sptr" ; hTargetAlg : BCRYPT_ALG_HANDLE optional -> "sptr" ; pbDerivedKey : BYTE* out -> "var" ; cbDerivedKey : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll" #cfunc global BCryptDeriveKeyCapi "BCryptDeriveKeyCapi" sptr, sptr, sptr, int, int ; res = BCryptDeriveKeyCapi(hHash, hTargetAlg, varptr(pbDerivedKey), cbDerivedKey, dwFlags) ; hHash : BCRYPT_HASH_HANDLE -> "sptr" ; hTargetAlg : BCRYPT_ALG_HANDLE optional -> "sptr" ; pbDerivedKey : BYTE* out -> "sptr" ; cbDerivedKey : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; NTSTATUS BCryptDeriveKeyCapi(BCRYPT_HASH_HANDLE hHash, BCRYPT_ALG_HANDLE hTargetAlg, BYTE* pbDerivedKey, DWORD cbDerivedKey, DWORD dwFlags) #uselib "bcrypt.dll" #cfunc global BCryptDeriveKeyCapi "BCryptDeriveKeyCapi" intptr, intptr, var, int, int ; res = BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags) ; hHash : BCRYPT_HASH_HANDLE -> "intptr" ; hTargetAlg : BCRYPT_ALG_HANDLE optional -> "intptr" ; pbDerivedKey : BYTE* out -> "var" ; cbDerivedKey : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; NTSTATUS BCryptDeriveKeyCapi(BCRYPT_HASH_HANDLE hHash, BCRYPT_ALG_HANDLE hTargetAlg, BYTE* pbDerivedKey, DWORD cbDerivedKey, DWORD dwFlags) #uselib "bcrypt.dll" #cfunc global BCryptDeriveKeyCapi "BCryptDeriveKeyCapi" intptr, intptr, intptr, int, int ; res = BCryptDeriveKeyCapi(hHash, hTargetAlg, varptr(pbDerivedKey), cbDerivedKey, dwFlags) ; hHash : BCRYPT_HASH_HANDLE -> "intptr" ; hTargetAlg : BCRYPT_ALG_HANDLE optional -> "intptr" ; pbDerivedKey : BYTE* out -> "intptr" ; cbDerivedKey : DWORD -> "int" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
procBCryptDeriveKeyCapi = bcrypt.NewProc("BCryptDeriveKeyCapi")
)
// hHash (BCRYPT_HASH_HANDLE), hTargetAlg (BCRYPT_ALG_HANDLE optional), pbDerivedKey (BYTE* out), cbDerivedKey (DWORD), dwFlags (DWORD)
r1, _, err := procBCryptDeriveKeyCapi.Call(
uintptr(hHash),
uintptr(hTargetAlg),
uintptr(pbDerivedKey),
uintptr(cbDerivedKey),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // NTSTATUSfunction BCryptDeriveKeyCapi(
hHash: THandle; // BCRYPT_HASH_HANDLE
hTargetAlg: THandle; // BCRYPT_ALG_HANDLE optional
pbDerivedKey: Pointer; // BYTE* out
cbDerivedKey: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptDeriveKeyCapi';result := DllCall("bcrypt\BCryptDeriveKeyCapi"
, "Ptr", hHash ; BCRYPT_HASH_HANDLE
, "Ptr", hTargetAlg ; BCRYPT_ALG_HANDLE optional
, "Ptr", pbDerivedKey ; BYTE* out
, "UInt", cbDerivedKey ; DWORD
, "UInt", dwFlags ; DWORD
, "Int") ; return: NTSTATUS●BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags) = DLL("bcrypt.dll", "int BCryptDeriveKeyCapi(void*, void*, void*, dword, dword)")
# 呼び出し: BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)
# hHash : BCRYPT_HASH_HANDLE -> "void*"
# hTargetAlg : BCRYPT_ALG_HANDLE optional -> "void*"
# pbDerivedKey : BYTE* out -> "void*"
# cbDerivedKey : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "bcrypt" fn BCryptDeriveKeyCapi(
hHash: ?*anyopaque, // BCRYPT_HASH_HANDLE
hTargetAlg: ?*anyopaque, // BCRYPT_ALG_HANDLE optional
pbDerivedKey: [*c]u8, // BYTE* out
cbDerivedKey: u32, // DWORD
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc BCryptDeriveKeyCapi(
hHash: pointer, # BCRYPT_HASH_HANDLE
hTargetAlg: pointer, # BCRYPT_ALG_HANDLE optional
pbDerivedKey: ptr uint8, # BYTE* out
cbDerivedKey: uint32, # DWORD
dwFlags: uint32 # DWORD
): int32 {.importc: "BCryptDeriveKeyCapi", stdcall, dynlib: "bcrypt.dll".}pragma(lib, "bcrypt");
extern(Windows)
int BCryptDeriveKeyCapi(
void* hHash, // BCRYPT_HASH_HANDLE
void* hTargetAlg, // BCRYPT_ALG_HANDLE optional
ubyte* pbDerivedKey, // BYTE* out
uint cbDerivedKey, // DWORD
uint dwFlags // DWORD
);ccall((:BCryptDeriveKeyCapi, "bcrypt.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt8}, UInt32, UInt32),
hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)
# hHash : BCRYPT_HASH_HANDLE -> Ptr{Cvoid}
# hTargetAlg : BCRYPT_ALG_HANDLE optional -> Ptr{Cvoid}
# pbDerivedKey : BYTE* out -> Ptr{UInt8}
# cbDerivedKey : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptDeriveKeyCapi(
void* hHash,
void* hTargetAlg,
uint8_t* pbDerivedKey,
uint32_t cbDerivedKey,
uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)
-- hHash : BCRYPT_HASH_HANDLE
-- hTargetAlg : BCRYPT_ALG_HANDLE optional
-- pbDerivedKey : BYTE* out
-- cbDerivedKey : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptDeriveKeyCapi = lib.func('__stdcall', 'BCryptDeriveKeyCapi', 'int32_t', ['void *', 'void *', 'uint8_t *', 'uint32_t', 'uint32_t']);
// BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)
// hHash : BCRYPT_HASH_HANDLE -> 'void *'
// hTargetAlg : BCRYPT_ALG_HANDLE optional -> 'void *'
// pbDerivedKey : BYTE* out -> 'uint8_t *'
// cbDerivedKey : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("bcrypt.dll", {
BCryptDeriveKeyCapi: { parameters: ["pointer", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags)
// hHash : BCRYPT_HASH_HANDLE -> "pointer"
// hTargetAlg : BCRYPT_ALG_HANDLE optional -> "pointer"
// pbDerivedKey : BYTE* out -> "pointer"
// cbDerivedKey : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptDeriveKeyCapi(
void* hHash,
void* hTargetAlg,
uint8_t* pbDerivedKey,
uint32_t cbDerivedKey,
uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptDeriveKeyCapi(hHash, hTargetAlg, pbDerivedKey, cbDerivedKey, dwFlags);
// hHash : BCRYPT_HASH_HANDLE
// hTargetAlg : BCRYPT_ALG_HANDLE optional
// pbDerivedKey : BYTE* out
// cbDerivedKey : DWORD
// dwFlags : DWORD
// 構造体/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 BCryptDeriveKeyCapi(
Pointer hHash, // BCRYPT_HASH_HANDLE
Pointer hTargetAlg, // BCRYPT_ALG_HANDLE optional
byte[] pbDerivedKey, // BYTE* out
int cbDerivedKey, // DWORD
int dwFlags // DWORD
);
}@[Link("bcrypt")]
lib Libbcrypt
fun BCryptDeriveKeyCapi = BCryptDeriveKeyCapi(
hHash : Void*, # BCRYPT_HASH_HANDLE
hTargetAlg : Void*, # BCRYPT_ALG_HANDLE optional
pbDerivedKey : UInt8*, # BYTE* out
cbDerivedKey : UInt32, # DWORD
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef BCryptDeriveKeyCapiNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint8>, Uint32, Uint32);
typedef BCryptDeriveKeyCapiDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint8>, int, int);
final BCryptDeriveKeyCapi = DynamicLibrary.open('bcrypt.dll')
.lookupFunction<BCryptDeriveKeyCapiNative, BCryptDeriveKeyCapiDart>('BCryptDeriveKeyCapi');
// hHash : BCRYPT_HASH_HANDLE -> Pointer<Void>
// hTargetAlg : BCRYPT_ALG_HANDLE optional -> Pointer<Void>
// pbDerivedKey : BYTE* out -> Pointer<Uint8>
// cbDerivedKey : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function BCryptDeriveKeyCapi(
hHash: THandle; // BCRYPT_HASH_HANDLE
hTargetAlg: THandle; // BCRYPT_ALG_HANDLE optional
pbDerivedKey: Pointer; // BYTE* out
cbDerivedKey: DWORD; // DWORD
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptDeriveKeyCapi';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "BCryptDeriveKeyCapi"
c_BCryptDeriveKeyCapi :: Ptr () -> Ptr () -> Ptr Word8 -> Word32 -> Word32 -> IO Int32
-- hHash : BCRYPT_HASH_HANDLE -> Ptr ()
-- hTargetAlg : BCRYPT_ALG_HANDLE optional -> Ptr ()
-- pbDerivedKey : BYTE* out -> Ptr Word8
-- cbDerivedKey : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let bcryptderivekeycapi =
foreign "BCryptDeriveKeyCapi"
((ptr void) @-> (ptr void) @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hHash : BCRYPT_HASH_HANDLE -> (ptr void) *)
(* hTargetAlg : BCRYPT_ALG_HANDLE optional -> (ptr void) *)
(* pbDerivedKey : BYTE* out -> (ptr uint8_t) *)
(* cbDerivedKey : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)
(cffi:defcfun ("BCryptDeriveKeyCapi" bcrypt-derive-key-capi :convention :stdcall) :int32
(h-hash :pointer) ; BCRYPT_HASH_HANDLE
(h-target-alg :pointer) ; BCRYPT_ALG_HANDLE optional
(pb-derived-key :pointer) ; BYTE* out
(cb-derived-key :uint32) ; DWORD
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $BCryptDeriveKeyCapi = Win32::API::More->new('bcrypt',
'int BCryptDeriveKeyCapi(HANDLE hHash, HANDLE hTargetAlg, LPVOID pbDerivedKey, DWORD cbDerivedKey, DWORD dwFlags)');
# my $ret = $BCryptDeriveKeyCapi->Call($hHash, $hTargetAlg, $pbDerivedKey, $cbDerivedKey, $dwFlags);
# hHash : BCRYPT_HASH_HANDLE -> HANDLE
# hTargetAlg : BCRYPT_ALG_HANDLE optional -> HANDLE
# pbDerivedKey : BYTE* out -> LPVOID
# cbDerivedKey : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。