ホーム › Security.Cryptography › CryptGetHashParam

CryptGetHashParam

関数

ハッシュオブジェクトのパラメータやハッシュ値を取得する。

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

シグネチャ

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

BOOL CryptGetHashParam(
    UINT_PTR hHash,
    DWORD dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hHash

UINT_PTR

照会対象のハッシュオブジェクトのハンドル。

dwParam

DWORD

照会の種類。このパラメーターには、次のいずれかの照会を指定できます。

値	意味
HP_ALGID ハッシュアルゴリズム	ハッシュオブジェクトの作成時に指定されたアルゴリズムを示す ALG_ID。ハッシュアルゴリズムの一覧については、 CryptCreateHash を参照してください。
HP_HASHSIZE ハッシュ値のサイズ	ハッシュ値のバイト数を示す DWORD 値。この値はハッシュアルゴリズムによって異なります。正しい量のメモリを割り当てられるように、アプリケーションは HP_HASHVAL 値を取得する直前にこの値を取得する必要があります。
HP_HASHVAL ハッシュ値	hHash で指定されたハッシュオブジェクトのハッシュ値またはメッセージハッシュ。この値は、これまでに CryptHashData 関数および CryptHashSessionKey 関数を通じてハッシュオブジェクトに与えられたデータに基づいて生成されます。 CryptGetHashParam 関数はハッシュを完了します。CryptGetHashParam を呼び出した後は、ハッシュにデータを追加できません。CryptHashData または CryptHashSessionKey を再度呼び出すと失敗します。アプリケーションがハッシュの使用を終えた後は、 CryptDestroyHash を呼び出してハッシュオブジェクトを破棄してください。

注意 CSP は、この関数で照会できる値を追加することがあります。

pbData

BYTE*

outoptional

指定された値のデータを受け取るバッファーへのポインター。このデータの形式は、値の番号によって異なります。

必要なメモリサイズを調べるために、このパラメーターを NULL にすることができます。

pdwDataLen

DWORD*

inout

pbData バッファーのサイズ (バイト単位) を指定する DWORD 値へのポインター。関数が戻るときに、この DWORD 値にはバッファーに格納されたバイト数が設定されます。

pbData が NULL の場合は、pdwDataLen の値をゼロに設定してください。

注意バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には通常、可能な限り最大の出力データがバッファーに収まるように十分大きなバッファーサイズを指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

dwFlags

DWORD

将来の使用のために予約されており、ゼロにする必要があります。

戻り値の型: BOOL

公式ドキュメント

ハッシュオブジェクトの動作を制御するデータを取得します。

戻り値

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

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

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

戻りコード	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが無効なハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。
ERROR_MORE_DATA	pbData パラメーターで指定されたバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pdwDataLen が指す変数に格納します。
NTE_BAD_FLAGS	dwFlags パラメーターがゼロ以外です。
NTE_BAD_HASH	hHash パラメーターで指定されたハッシュオブジェクトが無効です。
NTE_BAD_TYPE	dwParam パラメーターが不明な値の番号を指定しています。
NTE_BAD_UID	ハッシュの作成時に指定された 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 CryptGetHashParam(
    UINT_PTR hHash,
    DWORD dwParam,
    BYTE* pbData,   // optional
    DWORD* pdwDataLen,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetHashParam(
    UIntPtr hHash,   // UINT_PTR
    uint dwParam,   // DWORD
    IntPtr pbData,   // BYTE* optional, out
    ref uint pdwDataLen,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetHashParam(
    hHash As UIntPtr,   ' UINT_PTR
    dwParam As UInteger,   ' DWORD
    pbData As IntPtr,   ' BYTE* optional, out
    ByRef pdwDataLen As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHash : UINT_PTR
' dwParam : DWORD
' pbData : BYTE* optional, out
' pdwDataLen : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function CryptGetHashParam Lib "advapi32" ( _
    ByVal hHash As LongPtr, _
    ByVal dwParam As Long, _
    ByVal pbData As LongPtr, _
    ByRef pdwDataLen 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

CryptGetHashParam = ctypes.windll.advapi32.CryptGetHashParam
CryptGetHashParam.restype = wintypes.BOOL
CryptGetHashParam.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
    wintypes.DWORD,  # dwParam : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwDataLen : DWORD* in/out
    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')
CryptGetHashParam = Fiddle::Function.new(
  lib['CryptGetHashParam'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
    -Fiddle::TYPE_INT,  # dwParam : DWORD
    Fiddle::TYPE_VOIDP,  # pbData : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pdwDataLen : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptGetHashParam(
        hHash: usize,  // UINT_PTR
        dwParam: u32,  // DWORD
        pbData: *mut u8,  // BYTE* optional, out
        pdwDataLen: *mut u32,  // DWORD* in/out
        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 CryptGetHashParam(UIntPtr hHash, uint dwParam, IntPtr pbData, ref uint pdwDataLen, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGetHashParam' -Namespace Win32 -PassThru
# $api::CryptGetHashParam(hHash, dwParam, pbData, pdwDataLen, dwFlags)

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

出力引数:

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