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

BCryptHashData

関数
CNGのハッシュオブジェクトにデータを追加して処理する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptHashData(
    BCRYPT_HASH_HANDLE hHash,
    BYTE* pbInput,
    DWORD cbInput,
    DWORD dwFlags
);

パラメーター

名前方向説明
hHashBCRYPT_HASH_HANDLEinout操作の実行に使用するハッシュオブジェクトまたは MAC オブジェクトのハンドルです。このハンドルは、BCryptCreateHash 関数または BCryptDuplicateHash 関数を呼び出して取得します。
pbInputBYTE*in処理対象のデータを格納したバッファへのポインターです。このバッファ内のバイト数は cbInput パラメーターで指定します。この関数はこのバッファの内容を変更しません。
cbInputDWORDinpbInput バッファのサイズ(バイト単位)です。
dwFlagsDWORDinこの関数の動作を変更するフラグのセットです。現在定義されているフラグはないため、このパラメーターは 0 にする必要があります。

戻り値の型: NTSTATUS

公式ドキュメント

データバッファに対して一方向ハッシュまたはメッセージ認証コード(MAC)を実行します。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。
STATUS_INVALID_HANDLE hHash パラメーターのハンドルが無効です。BCryptFinishHash 関数を呼び出した後は、そのハンドルが BCRYPT_HASH_REUSABLE_FLAG フラグを指定して作成されたものでない限り、再利用できません。

解説(Remarks)

複数のバッファを 1 つのハッシュまたは MAC にまとめるには、この関数を複数回呼び出し、その都度異なるバッファを渡します。これは、これらのバッファを 1 つのバッファに連結して 1 回のハッシュ呼び出しまたは MAC 呼び出しを行うのと機能的には同等ですが、データがメモリ上で自然に連続していない場合にはこの方法のほうが便利なことが多くあります。

ハッシュ値または MAC 値を取得するには、BCryptFinishHash 関数を呼び出します。BCryptFinishHash 関数を呼び出した後は、hHash ハンドルが BCRYPT_HASH_REUSABLE_FLAG フラグを指定して作成されたものでない限り、再利用できません。

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

この関数をカーネルモードで呼び出すには、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 BCryptHashData(
    BCRYPT_HASH_HANDLE hHash,
    BYTE* pbInput,
    DWORD cbInput,
    DWORD dwFlags
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptHashData(
    IntPtr hHash,   // BCRYPT_HASH_HANDLE in/out
    IntPtr pbInput,   // BYTE*
    uint cbInput,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptHashData(
    hHash As IntPtr,   ' BCRYPT_HASH_HANDLE in/out
    pbInput As IntPtr,   ' BYTE*
    cbInput As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hHash : BCRYPT_HASH_HANDLE in/out
' pbInput : BYTE*
' cbInput : DWORD
' dwFlags : DWORD
Declare PtrSafe Function BCryptHashData Lib "bcrypt" ( _
    ByVal hHash As LongPtr, _
    ByVal pbInput As LongPtr, _
    ByVal cbInput 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

BCryptHashData = ctypes.windll.bcrypt.BCryptHashData
BCryptHashData.restype = ctypes.c_int
BCryptHashData.argtypes = [
    wintypes.HANDLE,  # hHash : BCRYPT_HASH_HANDLE in/out
    ctypes.POINTER(ctypes.c_ubyte),  # pbInput : BYTE*
    wintypes.DWORD,  # cbInput : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptHashData = bcrypt.NewProc("BCryptHashData")
)

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

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

foreign import stdcall safe "BCryptHashData"
  c_BCryptHashData :: Ptr () -> Ptr Word8 -> Word32 -> Word32 -> IO Int32
-- hHash : BCRYPT_HASH_HANDLE in/out -> Ptr ()
-- pbInput : BYTE* -> Ptr Word8
-- cbInput : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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