ホーム › Security.Cryptography › CryptHashPublicKeyInfo

CryptHashPublicKeyInfo

関数

公開鍵情報のハッシュ値を計算する。

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

シグネチャ

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

BOOL CryptHashPublicKeyInfo(
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    ALG_ID Algid,
    DWORD dwFlags,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

パラメーター

名前	型	方向	説明
hCryptProv	HCRYPTPROV_LEGACY	inoptional	このパラメーターは使用されないため、NULL に設定してください。 Windows Server 2003 および Windows XP: ハッシュの計算に使用する cryptographic service provider (CSP) のハンドル。このパラメーターのデータ型は HCRYPTPROV です。 hCryptProv に特定の暗号化プロバイダーを渡す強い理由がない限り、ゼロを渡します。ゼロを渡すと、ハッシュ、signature verification、または受信者の encryption 操作を行う前に、既定の RSA または Digital Signature Standard (DSS) プロバイダーが取得されます。
Algid	ALG_ID	in	使用する CryptoAPI ハッシュアルゴリズムを指定する ALG_ID 構造体。Algid がゼロの場合、既定のハッシュアルゴリズムである MD5 が使用されます。
dwFlags	DWORD	in	CryptCreateHash に渡される値。
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコードの種類を指定します。次の例に示すように、certificate と message encoding types の両方をビットごとの OR 演算で組み合わせて指定することは、常に許容されます。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコードの種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pInfo	CERT_PUBLIC_KEY_INFO*	in	エンコードおよびハッシュ化される public key 情報を含む CERT_PUBLIC_KEY_INFO 構造体へのポインター。
pbComputedHash	BYTE*	outoptional	計算されたハッシュを受け取るバッファーへのポインター。メモリ割り当てのためにこの情報のサイズを取得するには、このパラメーターを NULL にできます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbComputedHash	DWORD*	inout	pbComputedHash パラメーターが指すバッファーのサイズ (バイト単位) を含む DWORD へのポインター。関数が戻るとき、この DWORD にはバッファーに格納されたバイト数が含まれます。注バッファーで返されるデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。入力時には、想定される最大の出力データがバッファーに収まるよう、通常は十分に大きなバッファーサイズが指定されます。出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CERT_PUBLIC_KEY_INFO 構造体内の公開キー情報をエンコードし、エンコードされたバイト列のハッシュを計算します。

戻り値

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

関数が失敗した場合、ゼロ (FALSE) を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

注呼び出される関数 CryptCreateHash、 CryptGetHashParam、および CryptHashData からのエラーは、この関数に伝播される場合があります。この関数には次のエラーコードがあります。

戻りコード	説明
ERROR_MORE_DATA	pbComputedHash パラメーターで指定されたバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbComputedHash が指す変数に格納します。
ERROR_FILE_NOT_FOUND	無効な証明書エンコードの種類です。現在は X509_ASN_ENCODING のみがサポートされています。

関数が失敗した場合、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 CryptHashPublicKeyInfo(
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    ALG_ID Algid,
    DWORD dwFlags,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_PUBLIC_KEY_INFO* pInfo,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptHashPublicKeyInfo(
    UIntPtr hCryptProv,   // HCRYPTPROV_LEGACY optional
    uint Algid,   // ALG_ID
    uint dwFlags,   // DWORD
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pInfo,   // CERT_PUBLIC_KEY_INFO*
    IntPtr pbComputedHash,   // BYTE* optional, out
    ref uint pcbComputedHash   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptHashPublicKeyInfo(
    hCryptProv As UIntPtr,   ' HCRYPTPROV_LEGACY optional
    Algid As UInteger,   ' ALG_ID
    dwFlags As UInteger,   ' DWORD
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pInfo As IntPtr,   ' CERT_PUBLIC_KEY_INFO*
    pbComputedHash As IntPtr,   ' BYTE* optional, out
    ByRef pcbComputedHash As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCryptProv : HCRYPTPROV_LEGACY optional
' Algid : ALG_ID
' dwFlags : DWORD
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pInfo : CERT_PUBLIC_KEY_INFO*
' pbComputedHash : BYTE* optional, out
' pcbComputedHash : DWORD* in/out
Declare PtrSafe Function CryptHashPublicKeyInfo Lib "crypt32" ( _
    ByVal hCryptProv As LongPtr, _
    ByVal Algid As Long, _
    ByVal dwFlags As Long, _
    ByVal dwCertEncodingType As Long, _
    ByVal pInfo As LongPtr, _
    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

CryptHashPublicKeyInfo = ctypes.windll.crypt32.CryptHashPublicKeyInfo
CryptHashPublicKeyInfo.restype = wintypes.BOOL
CryptHashPublicKeyInfo.argtypes = [
    ctypes.c_size_t,  # hCryptProv : HCRYPTPROV_LEGACY optional
    wintypes.DWORD,  # Algid : ALG_ID
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.c_void_p,  # pInfo : CERT_PUBLIC_KEY_INFO*
    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')
CryptHashPublicKeyInfo = Fiddle::Function.new(
  lib['CryptHashPublicKeyInfo'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProv : HCRYPTPROV_LEGACY optional
    -Fiddle::TYPE_INT,  # Algid : ALG_ID
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pInfo : CERT_PUBLIC_KEY_INFO*
    Fiddle::TYPE_VOIDP,  # pbComputedHash : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbComputedHash : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptHashPublicKeyInfo(
        hCryptProv: usize,  // HCRYPTPROV_LEGACY optional
        Algid: u32,  // ALG_ID
        dwFlags: u32,  // DWORD
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pInfo: *mut CERT_PUBLIC_KEY_INFO,  // CERT_PUBLIC_KEY_INFO*
        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 CryptHashPublicKeyInfo(UIntPtr hCryptProv, uint Algid, uint dwFlags, uint dwCertEncodingType, IntPtr pInfo, IntPtr pbComputedHash, ref uint pcbComputedHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptHashPublicKeyInfo' -Namespace Win32 -PassThru
# $api::CryptHashPublicKeyInfo(hCryptProv, Algid, dwFlags, dwCertEncodingType, pInfo, pbComputedHash, pcbComputedHash)

#uselib "CRYPT32.dll"
#func global CryptHashPublicKeyInfo "CryptHashPublicKeyInfo" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptHashPublicKeyInfo hCryptProv, Algid, dwFlags, dwCertEncodingType, varptr(pInfo), varptr(pbComputedHash), varptr(pcbComputedHash)   ; 戻り値は stat
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; Algid : ALG_ID -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; pInfo : CERT_PUBLIC_KEY_INFO* -> "sptr"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptHashPublicKeyInfo "CryptHashPublicKeyInfo" sptr, int, int, int, var, var, var
; res = CryptHashPublicKeyInfo(hCryptProv, Algid, dwFlags, dwCertEncodingType, pInfo, pbComputedHash, pcbComputedHash)
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; Algid : ALG_ID -> "int"
; dwFlags : DWORD -> "int"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pInfo : CERT_PUBLIC_KEY_INFO* -> "var"
; pbComputedHash : BYTE* optional, out -> "var"
; pcbComputedHash : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptHashPublicKeyInfo "CryptHashPublicKeyInfo" sptr, int, int, int, sptr, sptr, sptr
; res = CryptHashPublicKeyInfo(hCryptProv, Algid, dwFlags, dwCertEncodingType, varptr(pInfo), varptr(pbComputedHash), varptr(pcbComputedHash))
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; Algid : ALG_ID -> "int"
; dwFlags : DWORD -> "int"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; pInfo : CERT_PUBLIC_KEY_INFO* -> "sptr"
; pbComputedHash : BYTE* optional, out -> "sptr"
; pcbComputedHash : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。