ホーム › Security.Cryptography › CryptVerifyDetachedMessageHash

CryptVerifyDetachedMessageHash

関数

分離ハッシュと元データを用いてハッシュを検証する。

DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptVerifyDetachedMessageHash(
    CRYPT_HASH_MESSAGE_PARA* pHashPara,
    BYTE* pbDetachedHashBlob,
    DWORD cbDetachedHashBlob,
    DWORD cToBeHashed,
    const BYTE** rgpbToBeHashed,
    DWORD* rgcbToBeHashed,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash   // optional
);

パラメーター

名前	型	方向	説明
pHashPara	CRYPT_HASH_MESSAGE_PARA*	in	ハッシュパラメーターを格納する CRYPT_HASH_MESSAGE_PARA 構造体へのポインター。
pbDetachedHashBlob	BYTE*	in	エンコードされた、分離されたハッシュへのポインター。
cbDetachedHashBlob	DWORD	in	分離されたハッシュのサイズ (バイト単位)。
cToBeHashed	DWORD	in	rgpbToBeHashed 配列および rgcbToBeHashed 配列の要素数。
rgpbToBeHashed	BYTE**	in	ハッシュ化対象のコンテンツバッファーへのポインターの配列。
rgcbToBeHashed	DWORD*	in	rgcbToBeHashed 配列の各要素が指すコンテンツバッファーのサイズ (バイト単位) の配列。
pbComputedHash	BYTE*	outoptional	計算されたハッシュを受け取るバッファーへのポインター。新しく作成されたハッシュが追加の処理に不要な場合、またはメモリ割り当てのためにハッシュのサイズを設定する場合は、このパラメーターを NULL にできます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbComputedHash	DWORD*	inoutoptional	pbComputedHash バッファーのサイズ (バイト単位) を指定する DWORD へのポインター。関数が返ると、この DWORD には作成されたハッシュのサイズ (バイト単位) が格納されます。このパラメーターが NULL の場合、ハッシュは返されません。 Note 返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には通常、出力されうる最大のデータが収まるよう、バッファーサイズは十分に大きく指定されます。) 出力時には、このパラメーターが指す変数は、バッファーにコピーされたデータの実際のサイズを反映するよう更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptVerifyDetachedMessageHash 関数は、分離されたハッシュを検証します。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

関数が失敗した場合、戻り値は 0 (FALSE) です。

拡張エラー情報を取得するには、 GetLastError を呼び出します。

以下に、 GetLastError 関数が返す最も一般的なエラーコードを示します。

戻り値コード	説明
CRYPT_E_UNEXPECTED_MSG_TYPE	ハッシュ化された暗号化メッセージではありません。
E_INVALIDARG	メッセージエンコードの種類が無効です。現在は PKCS_7_ASN_ENCODING のみがサポートされています。*pHashPara の cbSize が無効です。
ERROR_MORE_DATA	pbComputedHash パラメーターで指定したバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbComputedHash が指す変数に格納します。

Note 呼び出される関数 CryptCreateHash、 CryptHashData、 CryptGetHashParam からのエラーが、この関数に伝播される場合があります。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返すことがあります。これらのエラーについては、 ASN.1 Encoding/Decoding Return Values を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptVerifyDetachedMessageHash(
    CRYPT_HASH_MESSAGE_PARA* pHashPara,
    BYTE* pbDetachedHashBlob,
    DWORD cbDetachedHashBlob,
    DWORD cToBeHashed,
    const BYTE** rgpbToBeHashed,
    DWORD* rgcbToBeHashed,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptVerifyDetachedMessageHash(
    IntPtr pHashPara,   // CRYPT_HASH_MESSAGE_PARA*
    IntPtr pbDetachedHashBlob,   // BYTE*
    uint cbDetachedHashBlob,   // DWORD
    uint cToBeHashed,   // DWORD
    IntPtr rgpbToBeHashed,   // BYTE**
    ref uint rgcbToBeHashed,   // DWORD*
    IntPtr pbComputedHash,   // BYTE* optional, out
    IntPtr pcbComputedHash   // DWORD* optional, in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptVerifyDetachedMessageHash(
    pHashPara As IntPtr,   ' CRYPT_HASH_MESSAGE_PARA*
    pbDetachedHashBlob As IntPtr,   ' BYTE*
    cbDetachedHashBlob As UInteger,   ' DWORD
    cToBeHashed As UInteger,   ' DWORD
    rgpbToBeHashed As IntPtr,   ' BYTE**
    ByRef rgcbToBeHashed As UInteger,   ' DWORD*
    pbComputedHash As IntPtr,   ' BYTE* optional, out
    pcbComputedHash As IntPtr   ' DWORD* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pHashPara : CRYPT_HASH_MESSAGE_PARA*
' pbDetachedHashBlob : BYTE*
' cbDetachedHashBlob : DWORD
' cToBeHashed : DWORD
' rgpbToBeHashed : BYTE**
' rgcbToBeHashed : DWORD*
' pbComputedHash : BYTE* optional, out
' pcbComputedHash : DWORD* optional, in/out
Declare PtrSafe Function CryptVerifyDetachedMessageHash Lib "crypt32" ( _
    ByVal pHashPara As LongPtr, _
    ByVal pbDetachedHashBlob As LongPtr, _
    ByVal cbDetachedHashBlob As Long, _
    ByVal cToBeHashed As Long, _
    ByVal rgpbToBeHashed As LongPtr, _
    ByRef rgcbToBeHashed As Long, _
    ByVal pbComputedHash As LongPtr, _
    ByVal pcbComputedHash As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptVerifyDetachedMessageHash = ctypes.windll.crypt32.CryptVerifyDetachedMessageHash
CryptVerifyDetachedMessageHash.restype = wintypes.BOOL
CryptVerifyDetachedMessageHash.argtypes = [
    ctypes.c_void_p,  # pHashPara : CRYPT_HASH_MESSAGE_PARA*
    ctypes.POINTER(ctypes.c_ubyte),  # pbDetachedHashBlob : BYTE*
    wintypes.DWORD,  # cbDetachedHashBlob : DWORD
    wintypes.DWORD,  # cToBeHashed : DWORD
    ctypes.c_void_p,  # rgpbToBeHashed : BYTE**
    ctypes.POINTER(wintypes.DWORD),  # rgcbToBeHashed : DWORD*
    ctypes.POINTER(ctypes.c_ubyte),  # pbComputedHash : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbComputedHash : DWORD* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptVerifyDetachedMessageHash = Fiddle::Function.new(
  lib['CryptVerifyDetachedMessageHash'],
  [
    Fiddle::TYPE_VOIDP,  # pHashPara : CRYPT_HASH_MESSAGE_PARA*
    Fiddle::TYPE_VOIDP,  # pbDetachedHashBlob : BYTE*
    -Fiddle::TYPE_INT,  # cbDetachedHashBlob : DWORD
    -Fiddle::TYPE_INT,  # cToBeHashed : DWORD
    Fiddle::TYPE_VOIDP,  # rgpbToBeHashed : BYTE**
    Fiddle::TYPE_VOIDP,  # rgcbToBeHashed : DWORD*
    Fiddle::TYPE_VOIDP,  # pbComputedHash : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbComputedHash : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptVerifyDetachedMessageHash(
        pHashPara: *mut CRYPT_HASH_MESSAGE_PARA,  // CRYPT_HASH_MESSAGE_PARA*
        pbDetachedHashBlob: *mut u8,  // BYTE*
        cbDetachedHashBlob: u32,  // DWORD
        cToBeHashed: u32,  // DWORD
        rgpbToBeHashed: *const *const u8,  // BYTE**
        rgcbToBeHashed: *mut u32,  // DWORD*
        pbComputedHash: *mut u8,  // BYTE* optional, out
        pcbComputedHash: *mut u32  // DWORD* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptVerifyDetachedMessageHash(IntPtr pHashPara, IntPtr pbDetachedHashBlob, uint cbDetachedHashBlob, uint cToBeHashed, IntPtr rgpbToBeHashed, ref uint rgcbToBeHashed, IntPtr pbComputedHash, IntPtr pcbComputedHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptVerifyDetachedMessageHash' -Namespace Win32 -PassThru
# $api::CryptVerifyDetachedMessageHash(pHashPara, pbDetachedHashBlob, cbDetachedHashBlob, cToBeHashed, rgpbToBeHashed, rgcbToBeHashed, pbComputedHash, pcbComputedHash)

#uselib "CRYPT32.dll"
#func global CryptVerifyDetachedMessageHash "CryptVerifyDetachedMessageHash" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptVerifyDetachedMessageHash varptr(pHashPara), varptr(pbDetachedHashBlob), cbDetachedHashBlob, cToBeHashed, varptr(rgpbToBeHashed), varptr(rgcbToBeHashed), varptr(pbComputedHash), varptr(pcbComputedHash)   ; 戻り値は stat
; pHashPara : CRYPT_HASH_MESSAGE_PARA* -> "sptr"
; pbDetachedHashBlob : BYTE* -> "sptr"
; cbDetachedHashBlob : DWORD -> "sptr"
; cToBeHashed : DWORD -> "sptr"
; rgpbToBeHashed : BYTE** -> "sptr"
; rgcbToBeHashed : DWORD* -> "sptr"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptVerifyDetachedMessageHash "CryptVerifyDetachedMessageHash" var, var, int, int, var, var, var, var
; res = CryptVerifyDetachedMessageHash(pHashPara, pbDetachedHashBlob, cbDetachedHashBlob, cToBeHashed, rgpbToBeHashed, rgcbToBeHashed, pbComputedHash, pcbComputedHash)
; pHashPara : CRYPT_HASH_MESSAGE_PARA* -> "var"
; pbDetachedHashBlob : BYTE* -> "var"
; cbDetachedHashBlob : DWORD -> "int"
; cToBeHashed : DWORD -> "int"
; rgpbToBeHashed : BYTE** -> "var"
; rgcbToBeHashed : DWORD* -> "var"
; pbComputedHash : BYTE* optional, out -> "var"
; pcbComputedHash : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptVerifyDetachedMessageHash "CryptVerifyDetachedMessageHash" sptr, sptr, int, int, sptr, sptr, sptr, sptr
; res = CryptVerifyDetachedMessageHash(varptr(pHashPara), varptr(pbDetachedHashBlob), cbDetachedHashBlob, cToBeHashed, varptr(rgpbToBeHashed), varptr(rgcbToBeHashed), varptr(pbComputedHash), varptr(pcbComputedHash))
; pHashPara : CRYPT_HASH_MESSAGE_PARA* -> "sptr"
; pbDetachedHashBlob : BYTE* -> "sptr"
; cbDetachedHashBlob : DWORD -> "int"
; cToBeHashed : DWORD -> "int"
; rgpbToBeHashed : BYTE** -> "sptr"
; rgcbToBeHashed : DWORD* -> "sptr"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。