Win32 API 日本語リファレンス
ホームSecurity.Cryptography › BCryptDuplicateHash

BCryptDuplicateHash

関数
CNGのハッシュオブジェクトを複製する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptDuplicateHash(
    BCRYPT_HASH_HANDLE hHash,
    BCRYPT_HASH_HANDLE* phNewHash,
    BYTE* pbHashObject,   // optional
    DWORD cbHashObject,
    DWORD dwFlags
);

パラメーター

名前方向説明
hHashBCRYPT_HASH_HANDLEin複製するハッシュオブジェクトまたは MAC オブジェクトのハンドル。
phNewHashBCRYPT_HASH_HANDLE*out複製されたハッシュオブジェクトまたは MAC オブジェクトを表すハンドルを受け取る BCRYPT_HASH_HANDLE 値へのポインター。このハンドルは、BCryptHashData 関数などの後続のハッシュ関数または MAC 関数で使用します。このハンドルの使用を終えたら、BCryptDestroyHash 関数に渡して解放してください。
pbHashObjectBYTE*outoptional

複製されたハッシュオブジェクトまたは MAC オブジェクトを受け取るバッファーへのポインター。cbHashObject パラメーターには、このバッファーのサイズを指定します。このバッファーに必要なサイズは、BCryptGetProperty 関数を呼び出し、アルゴリズムハンドルまたはハッシュハンドルから BCRYPT_OBJECT_LENGTH プロパティを取得することで得られます。これにより、指定したアルゴリズムにおけるハッシュオブジェクトまたは MAC オブジェクトのサイズが得られます。

このメモリは、phHash パラメーターが指すハンドルが破棄された後にのみ解放できます。

このパラメーターの値が NULL で、かつ cbHashObject パラメーターの値が 0 の場合、ハッシュオブジェクト用のメモリはこの関数によって割り当てられ、BCryptDestroyHash によって解放されます。Windows 7: このメモリ管理機能は Windows 7 以降で利用できます。

cbHashObjectDWORDin

pbHashObject バッファーのサイズ (バイト単位)。

このパラメーターの値が 0 で、かつ pbHashObject パラメーターの値が NULL の場合、キーオブジェクト用のメモリはこの関数によって割り当てられ、BCryptDestroyHash によって解放されます。Windows 7: このメモリ管理機能は Windows 7 以降で利用できます。

dwFlagsDWORDinこの関数の動作を変更するフラグのセット。現在のところフラグは定義されていないため、このパラメーターは 0 にする必要があります。

戻り値の型: NTSTATUS

公式ドキュメント

既存のハッシュオブジェクトまたはメッセージ認証コード (MAC) オブジェクトを複製します。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_BUFFER_TOO_SMALL cbHashObject パラメーターで指定されたハッシュオブジェクトのサイズが、ハッシュオブジェクトを格納するのに十分ではありません。
STATUS_INVALID_HANDLE hHash パラメーターのハンドルが無効です。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。

解説(Remarks)

この関数は、共通データのブロックに対してハッシュまたは MAC を計算する場合に役立ちます。共通データを処理した後にハッシュオブジェクトまたは MAC オブジェクトを複製し、個々のオブジェクトに固有のデータを追加できます。

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptDuplicateHash はユーザーモードまたはカーネルモードのいずれからも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、hHash パラメーターに指定するハンドルは、BCRYPT_PROV_DISPATCH フラグを使用して開かれたプロバイダーが返したアルゴリズムハンドルから派生したものでなければならず、また BCryptDuplicateHash 関数に渡すすべてのポインターは、ページング不可 (またはロックされた) メモリを参照していなければなりません。

この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。

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

各言語での呼び出し定義

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

NTSTATUS BCryptDuplicateHash(
    BCRYPT_HASH_HANDLE hHash,
    BCRYPT_HASH_HANDLE* phNewHash,
    BYTE* pbHashObject,   // optional
    DWORD cbHashObject,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptDuplicateHash(
    IntPtr hHash,   // BCRYPT_HASH_HANDLE
    IntPtr phNewHash,   // BCRYPT_HASH_HANDLE* out
    IntPtr pbHashObject,   // BYTE* optional, out
    uint cbHashObject,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptDuplicateHash(
    hHash As IntPtr,   ' BCRYPT_HASH_HANDLE
    phNewHash As IntPtr,   ' BCRYPT_HASH_HANDLE* out
    pbHashObject As IntPtr,   ' BYTE* optional, out
    cbHashObject As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hHash : BCRYPT_HASH_HANDLE
' phNewHash : BCRYPT_HASH_HANDLE* out
' pbHashObject : BYTE* optional, out
' cbHashObject : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptDuplicateHash Lib "bcrypt" ( _
    ByVal hHash As LongPtr, _
    ByVal phNewHash As LongPtr, _
    ByVal pbHashObject As LongPtr, _
    ByVal cbHashObject 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

BCryptDuplicateHash = ctypes.windll.bcrypt.BCryptDuplicateHash
BCryptDuplicateHash.restype = ctypes.c_int
BCryptDuplicateHash.argtypes = [
    wintypes.HANDLE,  # hHash : BCRYPT_HASH_HANDLE
    ctypes.c_void_p,  # phNewHash : BCRYPT_HASH_HANDLE* out
    ctypes.POINTER(ctypes.c_ubyte),  # pbHashObject : BYTE* optional, out
    wintypes.DWORD,  # cbHashObject : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptDuplicateHash = Fiddle::Function.new(
  lib['BCryptDuplicateHash'],
  [
    Fiddle::TYPE_VOIDP,  # hHash : BCRYPT_HASH_HANDLE
    Fiddle::TYPE_VOIDP,  # phNewHash : BCRYPT_HASH_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pbHashObject : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbHashObject : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptDuplicateHash(
        hHash: *mut core::ffi::c_void,  // BCRYPT_HASH_HANDLE
        phNewHash: *mut *mut core::ffi::c_void,  // BCRYPT_HASH_HANDLE* out
        pbHashObject: *mut u8,  // BYTE* optional, out
        cbHashObject: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptDuplicateHash(IntPtr hHash, IntPtr phNewHash, IntPtr pbHashObject, uint cbHashObject, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptDuplicateHash' -Namespace Win32 -PassThru
# $api::BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
#uselib "bcrypt.dll"
#func global BCryptDuplicateHash "BCryptDuplicateHash" sptr, sptr, sptr, sptr, sptr
; BCryptDuplicateHash hHash, phNewHash, varptr(pbHashObject), cbHashObject, dwFlags   ; 戻り値は stat
; hHash : BCRYPT_HASH_HANDLE -> "sptr"
; phNewHash : BCRYPT_HASH_HANDLE* out -> "sptr"
; pbHashObject : BYTE* optional, out -> "sptr"
; cbHashObject : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "bcrypt.dll"
#cfunc global BCryptDuplicateHash "BCryptDuplicateHash" sptr, sptr, var, int, int
; res = BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
; hHash : BCRYPT_HASH_HANDLE -> "sptr"
; phNewHash : BCRYPT_HASH_HANDLE* out -> "sptr"
; pbHashObject : BYTE* optional, out -> "var"
; cbHashObject : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; NTSTATUS BCryptDuplicateHash(BCRYPT_HASH_HANDLE hHash, BCRYPT_HASH_HANDLE* phNewHash, BYTE* pbHashObject, DWORD cbHashObject, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptDuplicateHash "BCryptDuplicateHash" intptr, intptr, var, int, int
; res = BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
; hHash : BCRYPT_HASH_HANDLE -> "intptr"
; phNewHash : BCRYPT_HASH_HANDLE* out -> "intptr"
; pbHashObject : BYTE* optional, out -> "var"
; cbHashObject : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptDuplicateHash = bcrypt.NewProc("BCryptDuplicateHash")
)

// hHash (BCRYPT_HASH_HANDLE), phNewHash (BCRYPT_HASH_HANDLE* out), pbHashObject (BYTE* optional, out), cbHashObject (DWORD), dwFlags (DWORD)
r1, _, err := procBCryptDuplicateHash.Call(
	uintptr(hHash),
	uintptr(phNewHash),
	uintptr(pbHashObject),
	uintptr(cbHashObject),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptDuplicateHash(
  hHash: THandle;   // BCRYPT_HASH_HANDLE
  phNewHash: Pointer;   // BCRYPT_HASH_HANDLE* out
  pbHashObject: Pointer;   // BYTE* optional, out
  cbHashObject: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptDuplicateHash';
result := DllCall("bcrypt\BCryptDuplicateHash"
    , "Ptr", hHash   ; BCRYPT_HASH_HANDLE
    , "Ptr", phNewHash   ; BCRYPT_HASH_HANDLE* out
    , "Ptr", pbHashObject   ; BYTE* optional, out
    , "UInt", cbHashObject   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: NTSTATUS
●BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags) = DLL("bcrypt.dll", "int BCryptDuplicateHash(void*, void*, void*, dword, dword)")
# 呼び出し: BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
# hHash : BCRYPT_HASH_HANDLE -> "void*"
# phNewHash : BCRYPT_HASH_HANDLE* out -> "void*"
# pbHashObject : BYTE* optional, out -> "void*"
# cbHashObject : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "bcrypt" fn BCryptDuplicateHash(
    hHash: ?*anyopaque, // BCRYPT_HASH_HANDLE
    phNewHash: ?*anyopaque, // BCRYPT_HASH_HANDLE* out
    pbHashObject: [*c]u8, // BYTE* optional, out
    cbHashObject: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BCryptDuplicateHash(
    hHash: pointer,  # BCRYPT_HASH_HANDLE
    phNewHash: pointer,  # BCRYPT_HASH_HANDLE* out
    pbHashObject: ptr uint8,  # BYTE* optional, out
    cbHashObject: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "BCryptDuplicateHash", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptDuplicateHash(
    void* hHash,   // BCRYPT_HASH_HANDLE
    void* phNewHash,   // BCRYPT_HASH_HANDLE* out
    ubyte* pbHashObject,   // BYTE* optional, out
    uint cbHashObject,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:BCryptDuplicateHash, "bcrypt.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt8}, UInt32, UInt32),
      hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
# hHash : BCRYPT_HASH_HANDLE -> Ptr{Cvoid}
# phNewHash : BCRYPT_HASH_HANDLE* out -> Ptr{Cvoid}
# pbHashObject : BYTE* optional, out -> Ptr{UInt8}
# cbHashObject : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptDuplicateHash(
    void* hHash,
    void* phNewHash,
    uint8_t* pbHashObject,
    uint32_t cbHashObject,
    uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
-- hHash : BCRYPT_HASH_HANDLE
-- phNewHash : BCRYPT_HASH_HANDLE* out
-- pbHashObject : BYTE* optional, out
-- cbHashObject : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptDuplicateHash = lib.func('__stdcall', 'BCryptDuplicateHash', 'int32_t', ['void *', 'void *', 'uint8_t *', 'uint32_t', 'uint32_t']);
// BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
// hHash : BCRYPT_HASH_HANDLE -> 'void *'
// phNewHash : BCRYPT_HASH_HANDLE* out -> 'void *'
// pbHashObject : BYTE* optional, out -> 'uint8_t *'
// cbHashObject : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptDuplicateHash: { parameters: ["pointer", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags)
// hHash : BCRYPT_HASH_HANDLE -> "pointer"
// phNewHash : BCRYPT_HASH_HANDLE* out -> "pointer"
// pbHashObject : BYTE* optional, out -> "pointer"
// cbHashObject : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptDuplicateHash(
    void* hHash,
    void* phNewHash,
    uint8_t* pbHashObject,
    uint32_t cbHashObject,
    uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptDuplicateHash(hHash, phNewHash, pbHashObject, cbHashObject, dwFlags);
// hHash : BCRYPT_HASH_HANDLE
// phNewHash : BCRYPT_HASH_HANDLE* out
// pbHashObject : BYTE* optional, out
// cbHashObject : 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 BCryptDuplicateHash(
        Pointer hHash,   // BCRYPT_HASH_HANDLE
        Pointer phNewHash,   // BCRYPT_HASH_HANDLE* out
        byte[] pbHashObject,   // BYTE* optional, out
        int cbHashObject,   // DWORD
        int dwFlags   // DWORD
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptDuplicateHash = BCryptDuplicateHash(
    hHash : Void*,   # BCRYPT_HASH_HANDLE
    phNewHash : Void*,   # BCRYPT_HASH_HANDLE* out
    pbHashObject : UInt8*,   # BYTE* optional, out
    cbHashObject : 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 BCryptDuplicateHashNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint8>, Uint32, Uint32);
typedef BCryptDuplicateHashDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint8>, int, int);
final BCryptDuplicateHash = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptDuplicateHashNative, BCryptDuplicateHashDart>('BCryptDuplicateHash');
// hHash : BCRYPT_HASH_HANDLE -> Pointer<Void>
// phNewHash : BCRYPT_HASH_HANDLE* out -> Pointer<Void>
// pbHashObject : BYTE* optional, out -> Pointer<Uint8>
// cbHashObject : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptDuplicateHash(
  hHash: THandle;   // BCRYPT_HASH_HANDLE
  phNewHash: Pointer;   // BCRYPT_HASH_HANDLE* out
  pbHashObject: Pointer;   // BYTE* optional, out
  cbHashObject: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptDuplicateHash';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptDuplicateHash"
  c_BCryptDuplicateHash :: Ptr () -> Ptr () -> Ptr Word8 -> Word32 -> Word32 -> IO Int32
-- hHash : BCRYPT_HASH_HANDLE -> Ptr ()
-- phNewHash : BCRYPT_HASH_HANDLE* out -> Ptr ()
-- pbHashObject : BYTE* optional, out -> Ptr Word8
-- cbHashObject : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptduplicatehash =
  foreign "BCryptDuplicateHash"
    ((ptr void) @-> (ptr void) @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hHash : BCRYPT_HASH_HANDLE -> (ptr void) *)
(* phNewHash : BCRYPT_HASH_HANDLE* out -> (ptr void) *)
(* pbHashObject : BYTE* optional, out -> (ptr uint8_t) *)
(* cbHashObject : 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 ("BCryptDuplicateHash" bcrypt-duplicate-hash :convention :stdcall) :int32
  (h-hash :pointer)   ; BCRYPT_HASH_HANDLE
  (ph-new-hash :pointer)   ; BCRYPT_HASH_HANDLE* out
  (pb-hash-object :pointer)   ; BYTE* optional, out
  (cb-hash-object :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptDuplicateHash = Win32::API::More->new('bcrypt',
    'int BCryptDuplicateHash(HANDLE hHash, HANDLE phNewHash, LPVOID pbHashObject, DWORD cbHashObject, DWORD dwFlags)');
# my $ret = $BCryptDuplicateHash->Call($hHash, $phNewHash, $pbHashObject, $cbHashObject, $dwFlags);
# hHash : BCRYPT_HASH_HANDLE -> HANDLE
# phNewHash : BCRYPT_HASH_HANDLE* out -> HANDLE
# pbHashObject : BYTE* optional, out -> LPVOID
# cbHashObject : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。