ホーム › Security.Cryptography › CryptHashData

CryptHashData

関数

ハッシュオブジェクトにデータを追加してハッシュを計算する。

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

シグネチャ

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

BOOL CryptHashData(
    UINT_PTR hHash,
    const BYTE* pbData,
    DWORD dwDataLen,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hHash

UINT_PTR

ハッシュオブジェクトのハンドルです。

pbData

BYTE*

ハッシュオブジェクトに追加するデータを格納したバッファへのポインターです。

dwDataLen

DWORD

追加するデータのバイト数です。CRYPT_USERDATA フラグが設定されている場合は、これをゼロにする必要があります。

dwFlags

DWORD

次のフラグ値が定義されています。

値

意味

CRYPT_OWF_REPL_LM_HASH
0x00000001

このフラグは使用されません。

CRYPT_USERDATA
1 (0x1)

すべての Microsoft 暗号化プロバイダーはこのパラメーターを無視します。このパラメーターを無視しない CSP の場合、このフラグが設定されていると、CSP はユーザーにデータを直接入力するよう求めます。このデータはハッシュに追加されます。アプリケーションはこのデータにアクセスできません。このフラグは、ユーザーがシステムに PIN を入力できるようにするために使用できます。

戻り値の型: BOOL

公式ドキュメント

指定したハッシュオブジェクトにデータを追加します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

"NTE" で始まるエラーコードは、使用している特定の CSP によって生成されます。考えられるエラーコードの一部を次に示します。

戻り値コード	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが、有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに有効でない値が含まれています。これは多くの場合、有効でないポインターです。
NTE_BAD_ALGID	hHash ハンドルが、この CSP がサポートしていないアルゴリズムを指定しています。
NTE_BAD_FLAGS	dwFlags パラメーターに有効でない値が含まれています。
NTE_BAD_HASH	hHash パラメーターで指定されたハッシュオブジェクトが有効ではありません。
NTE_BAD_HASH_STATE	すでに「完了」とマークされているハッシュオブジェクトにデータを追加しようとしました。
NTE_BAD_KEY	キー付きハッシュアルゴリズムが使用されていますが、セッションキーが既に無効になっています。このエラーは、ハッシュ操作が完了する前にセッションキーが破棄された場合に生成されます。
NTE_BAD_LEN	CSP が CRYPT_USERDATA フラグを無視せず、そのフラグが設定されており、かつ dwDataLen パラメーターがゼロ以外の値になっています。
NTE_BAD_UID	ハッシュオブジェクトの作成時に指定された CSP コンテキストが見つかりません。
NTE_FAIL	関数が予期しない形で失敗しました。
NTE_NO_MEMORY	操作中に CSP のメモリが不足しました。

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

各言語での呼び出し定義

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

BOOL CryptHashData(
    UINT_PTR hHash,
    const BYTE* pbData,
    DWORD dwDataLen,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptHashData(
    UIntPtr hHash,   // UINT_PTR
    IntPtr pbData,   // BYTE*
    uint dwDataLen,   // DWORD
    uint dwFlags   // DWORD
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptHashData(
    hHash As UIntPtr,   ' UINT_PTR
    pbData As IntPtr,   ' BYTE*
    dwDataLen As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHash : UINT_PTR
' pbData : BYTE*
' dwDataLen : DWORD
' dwFlags : DWORD
Declare PtrSafe Function CryptHashData Lib "advapi32" ( _
    ByVal hHash As LongPtr, _
    ByVal pbData As LongPtr, _
    ByVal dwDataLen 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

CryptHashData = ctypes.windll.advapi32.CryptHashData
CryptHashData.restype = wintypes.BOOL
CryptHashData.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE*
    wintypes.DWORD,  # dwDataLen : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptHashData = Fiddle::Function.new(
  lib['CryptHashData'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pbData : BYTE*
    -Fiddle::TYPE_INT,  # dwDataLen : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptHashData(
        hHash: usize,  // UINT_PTR
        pbData: *const u8,  // BYTE*
        dwDataLen: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool CryptHashData(UIntPtr hHash, IntPtr pbData, uint dwDataLen, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptHashData' -Namespace Win32 -PassThru
# $api::CryptHashData(hHash, pbData, dwDataLen, dwFlags)

#uselib "ADVAPI32.dll"
#func global CryptHashData "CryptHashData" sptr, sptr, sptr, sptr
; CryptHashData hHash, varptr(pbData), dwDataLen, dwFlags   ; 戻り値は stat
; hHash : UINT_PTR -> "sptr"
; pbData : BYTE* -> "sptr"
; dwDataLen : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CryptHashData "CryptHashData" sptr, var, int, int
; res = CryptHashData(hHash, pbData, dwDataLen, dwFlags)
; hHash : UINT_PTR -> "sptr"
; pbData : BYTE* -> "var"
; dwDataLen : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CryptHashData "CryptHashData" sptr, sptr, int, int
; res = CryptHashData(hHash, varptr(pbData), dwDataLen, dwFlags)
; hHash : UINT_PTR -> "sptr"
; pbData : BYTE* -> "sptr"
; dwDataLen : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。