ホーム › Security.Cryptography › CryptHashToBeSigned

CryptHashToBeSigned

関数

エンコードされた証明書の被署名部分のハッシュを計算する。

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

シグネチャ

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

BOOL CryptHashToBeSigned(
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbEncoded,
    DWORD cbEncoded,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

パラメーター

名前	型	方向	説明
hCryptProv	HCRYPTPROV_LEGACY	inoptional	このパラメーターは使用されず、NULL に設定する必要があります。 Windows Server 2003 および Windows XP: ハッシュの計算に使用する暗号化サービスプロバイダー (CSP) のハンドルです。このパラメーターのデータ型は HCRYPTPROV です。 hCryptProv で特定の暗号化プロバイダーを渡す明確な理由がない限り、0 を渡します。0 を渡すと、ハッシュ、署名の検証、または受信者の暗号化の各操作を行う前に、既定の RSA または Digital Signature Standard (DSS) プロバイダーが取得されます。
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコーディングの種類を指定します。次の例に示すように、証明書とメッセージのエンコーディングの種類の両方をビット単位の OR 演算で組み合わせて指定することは常に可能です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコーディングの種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pbEncoded	BYTE*	in	ハッシュ化するコンテンツを格納するバッファーのアドレスです。これは CERT_SIGNED_CONTENT_INFO のエンコードされた形式です。
cbEncoded	DWORD	in	バッファーのサイズ (バイト単位) です。
pbComputedHash	BYTE*	outoptional	計算されたハッシュを受け取るバッファーへのポインターです。このパラメーターには、メモリ割り当てのためにこの情報のサイズを取得する目的で NULL を指定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbComputedHash	DWORD*	inout	pbComputedHash パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD へのポインターです。関数が戻るとき、この DWORD にはバッファーに格納されたバイト数が格納されます。注バッファーで返されるデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。入力時には、想定される最大の出力データがバッファーに収まるように、通常はバッファーサイズを十分大きく指定します。出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

重要この API は非推奨です。(CryptHashToBeSigned)

戻り値

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

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

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

戻り値	説明
ERROR_MORE_DATA	pbComputedHash パラメーターで指定されたバッファーが、返されるデータを格納するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbComputedHash が指す変数に格納します。
ERROR_FILE_NOT_FOUND	証明書のエンコーディングの種類が無効です。現在サポートされているのは X509_ASN_ENCODING のみです。
NTE_BAD_ALGID	署名アルゴリズムのオブジェクト識別子 (OID) が、既知またはサポートされているハッシュアルゴリズムにマップされません。

関数が失敗した場合、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 CryptHashToBeSigned(
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbEncoded,
    DWORD cbEncoded,
    BYTE* pbComputedHash,   // optional
    DWORD* pcbComputedHash
);

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

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

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

CryptHashToBeSigned = ctypes.windll.crypt32.CryptHashToBeSigned
CryptHashToBeSigned.restype = wintypes.BOOL
CryptHashToBeSigned.argtypes = [
    ctypes.c_size_t,  # hCryptProv : HCRYPTPROV_LEGACY optional
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncoded : BYTE*
    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')
CryptHashToBeSigned = Fiddle::Function.new(
  lib['CryptHashToBeSigned'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hCryptProv : HCRYPTPROV_LEGACY optional
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pbEncoded : BYTE*
    -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 CryptHashToBeSigned(
        hCryptProv: usize,  // HCRYPTPROV_LEGACY optional
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pbEncoded: *const u8,  // BYTE*
        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 CryptHashToBeSigned(UIntPtr hCryptProv, uint dwCertEncodingType, IntPtr pbEncoded, uint cbEncoded, IntPtr pbComputedHash, ref uint pcbComputedHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptHashToBeSigned' -Namespace Win32 -PassThru
# $api::CryptHashToBeSigned(hCryptProv, dwCertEncodingType, pbEncoded, cbEncoded, pbComputedHash, pcbComputedHash)

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

出力引数:

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