ホーム › Security.Cryptography › CryptHashCertificate2

CryptHashCertificate2

関数

CNGハッシュアルゴリズムでエンコード済みデータのハッシュを計算する。

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

シグネチャ

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

BOOL CryptHashCertificate2(
    LPCWSTR pwszCNGHashAlgid,
    DWORD dwFlags,
    void* pvReserved,   // optional
    const BYTE* pbEncoded,   // optional
    DWORD cbEncoded,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

パラメーター

名前	型	方向	説明
pwszCNGHashAlgid	LPCWSTR	in	証明書のハッシュに使用するハッシュアルゴリズムの CNG ハッシュアルゴリズム識別子を含む、null で終わる Unicode 文字列のアドレス。これは、ハッシュアルゴリズムを表す CNG Algorithm Identifiers のいずれか、または登録済みのその他のハッシュアルゴリズム識別子を指定できます。
dwFlags	DWORD	in	この関数の動作を変更するフラグのセット。この関数に対して定義されているフラグはありません。
pvReserved	void*	optional	将来の使用のために予約されており、NULL である必要があります。
pbEncoded	BYTE*	inoptional	ハッシュするバイト配列のアドレス。cbEncoded パラメーターにこの配列のサイズが格納されます。
cbEncoded	DWORD	in	pbEncoded 配列内の要素数。
pbComputedHash	BYTE*	outoptional	計算されたハッシュを受け取るバッファーのアドレス。pcbComputedHash パラメーターが指す変数には、このバッファーのサイズが格納されます。
pcbComputedHash	DWORD*	inout	DWORD 変数のアドレス。入力時には、pbComputedHash バッファーのサイズ (バイト単位) が格納されます。この関数が戻った後、この変数には pbComputedHash バッファーにコピーされたバイト数が格納されます。

戻り値の型: BOOL

公式ドキュメント

CNG ハッシュプロバイダーを使用してデータブロックをハッシュします。

戻り値

関数が成功した場合、関数は 0 以外 (TRUE) を返します。

関数が失敗した場合は、0 (FALSE) を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの一部は、次のトピックで説明されています。

BCryptOpenAlgorithmProvider

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

各言語での呼び出し定義

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

BOOL CryptHashCertificate2(
    LPCWSTR pwszCNGHashAlgid,
    DWORD dwFlags,
    void* pvReserved,   // optional
    const BYTE* pbEncoded,   // optional
    DWORD cbEncoded,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptHashCertificate2(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszCNGHashAlgid,   // LPCWSTR
    uint dwFlags,   // DWORD
    IntPtr pvReserved,   // void* optional
    IntPtr pbEncoded,   // BYTE* optional
    uint cbEncoded,   // DWORD
    IntPtr pbComputedHash,   // BYTE* optional, out
    ref uint pcbComputedHash   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptHashCertificate2(
    <MarshalAs(UnmanagedType.LPWStr)> pwszCNGHashAlgid As String,   ' LPCWSTR
    dwFlags As UInteger,   ' DWORD
    pvReserved As IntPtr,   ' void* optional
    pbEncoded As IntPtr,   ' BYTE* optional
    cbEncoded As UInteger,   ' DWORD
    pbComputedHash As IntPtr,   ' BYTE* optional, out
    ByRef pcbComputedHash As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pwszCNGHashAlgid : LPCWSTR
' dwFlags : DWORD
' pvReserved : void* optional
' pbEncoded : BYTE* optional
' cbEncoded : DWORD
' pbComputedHash : BYTE* optional, out
' pcbComputedHash : DWORD* in/out
Declare PtrSafe Function CryptHashCertificate2 Lib "crypt32" ( _
    ByVal pwszCNGHashAlgid As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pvReserved As LongPtr, _
    ByVal pbEncoded As LongPtr, _
    ByVal cbEncoded As Long, _
    ByVal pbComputedHash As LongPtr, _
    ByRef pcbComputedHash As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptHashCertificate2 = ctypes.windll.crypt32.CryptHashCertificate2
CryptHashCertificate2.restype = wintypes.BOOL
CryptHashCertificate2.argtypes = [
    wintypes.LPCWSTR,  # pwszCNGHashAlgid : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncoded : BYTE* optional
    wintypes.DWORD,  # cbEncoded : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbComputedHash : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbComputedHash : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptHashCertificate2 = Fiddle::Function.new(
  lib['CryptHashCertificate2'],
  [
    Fiddle::TYPE_VOIDP,  # pwszCNGHashAlgid : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pbEncoded : BYTE* optional
    -Fiddle::TYPE_INT,  # cbEncoded : DWORD
    Fiddle::TYPE_VOIDP,  # pbComputedHash : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbComputedHash : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptHashCertificate2(
        pwszCNGHashAlgid: *const u16,  // LPCWSTR
        dwFlags: u32,  // DWORD
        pvReserved: *mut (),  // void* optional
        pbEncoded: *const u8,  // BYTE* optional
        cbEncoded: u32,  // DWORD
        pbComputedHash: *mut u8,  // BYTE* optional, out
        pcbComputedHash: *mut u32  // DWORD* 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 CryptHashCertificate2([MarshalAs(UnmanagedType.LPWStr)] string pwszCNGHashAlgid, uint dwFlags, IntPtr pvReserved, IntPtr pbEncoded, uint cbEncoded, IntPtr pbComputedHash, ref uint pcbComputedHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptHashCertificate2' -Namespace Win32 -PassThru
# $api::CryptHashCertificate2(pwszCNGHashAlgid, dwFlags, pvReserved, pbEncoded, cbEncoded, pbComputedHash, pcbComputedHash)

#uselib "CRYPT32.dll"
#func global CryptHashCertificate2 "CryptHashCertificate2" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptHashCertificate2 pwszCNGHashAlgid, dwFlags, pvReserved, varptr(pbEncoded), cbEncoded, varptr(pbComputedHash), varptr(pcbComputedHash)   ; 戻り値は stat
; pwszCNGHashAlgid : LPCWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvReserved : void* optional -> "sptr"
; pbEncoded : BYTE* optional -> "sptr"
; cbEncoded : DWORD -> "sptr"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptHashCertificate2 "CryptHashCertificate2" wstr, int, sptr, var, int, var, var
; res = CryptHashCertificate2(pwszCNGHashAlgid, dwFlags, pvReserved, pbEncoded, cbEncoded, pbComputedHash, pcbComputedHash)
; pwszCNGHashAlgid : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; pvReserved : void* optional -> "sptr"
; pbEncoded : BYTE* optional -> "var"
; cbEncoded : DWORD -> "int"
; pbComputedHash : BYTE* optional, out -> "var"
; pcbComputedHash : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptHashCertificate2 "CryptHashCertificate2" wstr, int, sptr, sptr, int, sptr, sptr
; res = CryptHashCertificate2(pwszCNGHashAlgid, dwFlags, pvReserved, varptr(pbEncoded), cbEncoded, varptr(pbComputedHash), varptr(pcbComputedHash))
; pwszCNGHashAlgid : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; pvReserved : void* optional -> "sptr"
; pbEncoded : BYTE* optional -> "sptr"
; cbEncoded : DWORD -> "int"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。