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

BCryptFinishHash

関数
CNGのハッシュ計算を完了し最終ハッシュ値を取得する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptFinishHash(
    BCRYPT_HASH_HANDLE hHash,
    BYTE* pbOutput,
    DWORD cbOutput,
    DWORD dwFlags
);

パラメーター

名前方向説明
hHashBCRYPT_HASH_HANDLEinout操作の実行に使用するハッシュまたは MAC オブジェクトのハンドル。このハンドルは、BCryptCreateHash 関数または BCryptDuplicateHash 関数を呼び出して取得します。この関数が呼び出された後は、BCRYPT_HASH_REUSABLE_FLAG フラグを指定して作成された場合を除き、hHash ハンドルを再利用することはできません。
pbOutputBYTE*outハッシュ値または MAC 値を受け取るバッファーへのポインター。cbOutput パラメーターには、このバッファーのサイズを指定します。
cbOutputDWORDin

pbOutput バッファーのサイズ (バイト単位)。ハッシュ値または MAC 値が固定サイズの場合、このサイズはその値のサイズと正確に一致している必要があります。

このサイズは、BCryptGetProperty 関数を呼び出して BCRYPT_HASH_LENGTH プロパティを取得することで得られます。これにより、指定したアルゴリズムのハッシュ値または MAC 値のサイズが得られます。SHAKE256 などの拡張可能出力関数 (XOF) では可変の出力サイズがサポートされる場合がありますが、XOF の完全な安全性を維持する既定のサイズを BCRYPT_HASH_LENGTH で照会できます。

dwFlagsDWORDin

この関数の動作を変更する一連のフラグ。

ゼロ、または以下の値の 1 つ以上の組み合わせを指定できます。

意味
BCRYPT_HASH_DONT_RESET_FLAG このフラグは、SHAKE、CSHAKE、KMAC などの拡張可能出力関数 (XOF) にのみ適用されます。XOF は可変の出力サイズをサポートしており、このフラグを使用すると、その可変出力を段階的に取り出すことができます。このフラグを指定すると、この BCryptFinishHash の呼び出しによって hHash ハンドルがリセットされません。つまり、さらに BCryptFinishHash を呼び出して追加の出力を取り出すことができます。このフラグを指定せずに BCryptFinishHash を最後に呼び出すと、XOF 以外のアルゴリズムに対する BCryptFinishHash の呼び出しと同様に、XOF 操作の状態がリセットされます。

Windows 11 バージョン 24H2: XOF のサポートが開始されます。

戻り値の型: NTSTATUS

公式ドキュメント

BCryptHashData への以前の呼び出しで蓄積されたデータについて、ハッシュ値またはメッセージ認証コード (MAC) の値を取得します。

戻り値

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

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

戻り値 説明
STATUS_SUCCESS 関数は成功しました。
STATUS_INVALID_HANDLE hHash パラメーターのハッシュ ハンドルが無効です。
STATUS_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。これには、cbOutput がハッシュまたは MAC の固定サイズ出力と同じサイズでない場合が含まれます。

解説(Remarks)

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

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

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

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

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptFinishHash = bcrypt.NewProc("BCryptFinishHash")
)

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

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

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

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