ホーム › Security.Cryptography › CryptVerifyMessageHash

CryptVerifyMessageHash

関数

ハッシュ付きメッセージのハッシュ値を検証する。

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

シグネチャ

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

BOOL CryptVerifyMessageHash(
    CRYPT_HASH_MESSAGE_PARA* pHashPara,
    BYTE* pbHashedBlob,
    DWORD cbHashedBlob,
    BYTE* pbToBeHashed,   // optional
    DWORD* pcbToBeHashed,   // optional
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

CryptVerifyMessageHash 関数は、指定されたコンテンツのハッシュを検証します。

戻り値

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

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

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

以下に、 GetLastError 関数によって最も一般的に返されるエラーコードを示します。

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

注意呼び出された関数 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 CryptVerifyMessageHash(
    CRYPT_HASH_MESSAGE_PARA* pHashPara,
    BYTE* pbHashedBlob,
    DWORD cbHashedBlob,
    BYTE* pbToBeHashed,   // optional
    DWORD* pcbToBeHashed,   // optional
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptVerifyMessageHash(
    IntPtr pHashPara,   // CRYPT_HASH_MESSAGE_PARA*
    IntPtr pbHashedBlob,   // BYTE*
    uint cbHashedBlob,   // DWORD
    IntPtr pbToBeHashed,   // BYTE* optional, out
    IntPtr pcbToBeHashed,   // DWORD* optional, in/out
    IntPtr pbComputedHash,   // BYTE* optional, out
    IntPtr pcbComputedHash   // DWORD* optional, in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptVerifyMessageHash(
    pHashPara As IntPtr,   ' CRYPT_HASH_MESSAGE_PARA*
    pbHashedBlob As IntPtr,   ' BYTE*
    cbHashedBlob As UInteger,   ' DWORD
    pbToBeHashed As IntPtr,   ' BYTE* optional, out
    pcbToBeHashed As IntPtr,   ' DWORD* optional, in/out
    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*
' pbHashedBlob : BYTE*
' cbHashedBlob : DWORD
' pbToBeHashed : BYTE* optional, out
' pcbToBeHashed : DWORD* optional, in/out
' pbComputedHash : BYTE* optional, out
' pcbComputedHash : DWORD* optional, in/out
Declare PtrSafe Function CryptVerifyMessageHash Lib "crypt32" ( _
    ByVal pHashPara As LongPtr, _
    ByVal pbHashedBlob As LongPtr, _
    ByVal cbHashedBlob As Long, _
    ByVal pbToBeHashed As LongPtr, _
    ByVal pcbToBeHashed As LongPtr, _
    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

CryptVerifyMessageHash = ctypes.windll.crypt32.CryptVerifyMessageHash
CryptVerifyMessageHash.restype = wintypes.BOOL
CryptVerifyMessageHash.argtypes = [
    ctypes.c_void_p,  # pHashPara : CRYPT_HASH_MESSAGE_PARA*
    ctypes.POINTER(ctypes.c_ubyte),  # pbHashedBlob : BYTE*
    wintypes.DWORD,  # cbHashedBlob : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbToBeHashed : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbToBeHashed : DWORD* optional, in/out
    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')
CryptVerifyMessageHash = Fiddle::Function.new(
  lib['CryptVerifyMessageHash'],
  [
    Fiddle::TYPE_VOIDP,  # pHashPara : CRYPT_HASH_MESSAGE_PARA*
    Fiddle::TYPE_VOIDP,  # pbHashedBlob : BYTE*
    -Fiddle::TYPE_INT,  # cbHashedBlob : DWORD
    Fiddle::TYPE_VOIDP,  # pbToBeHashed : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbToBeHashed : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pbComputedHash : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbComputedHash : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptVerifyMessageHash(
        pHashPara: *mut CRYPT_HASH_MESSAGE_PARA,  // CRYPT_HASH_MESSAGE_PARA*
        pbHashedBlob: *mut u8,  // BYTE*
        cbHashedBlob: u32,  // DWORD
        pbToBeHashed: *mut u8,  // BYTE* optional, out
        pcbToBeHashed: *mut u32,  // DWORD* optional, in/out
        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 CryptVerifyMessageHash(IntPtr pHashPara, IntPtr pbHashedBlob, uint cbHashedBlob, IntPtr pbToBeHashed, IntPtr pcbToBeHashed, IntPtr pbComputedHash, IntPtr pcbComputedHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptVerifyMessageHash' -Namespace Win32 -PassThru
# $api::CryptVerifyMessageHash(pHashPara, pbHashedBlob, cbHashedBlob, pbToBeHashed, pcbToBeHashed, pbComputedHash, pcbComputedHash)

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

出力引数:

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