ホーム › Security.Cryptography › CryptVerifySignatureA

CryptVerifySignatureA

関数

公開鍵を使いハッシュのデジタル署名を検証する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptVerifySignatureA(
    UINT_PTR hHash,
    const BYTE* pbSignature,
    DWORD dwSigLen,
    UINT_PTR hPubKey,
    LPCSTR szDescription,   // optional
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hHash

UINT_PTR

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

pbSignature

BYTE*

検証する署名データのアドレス。

dwSigLen

DWORD

pbSignature 署名データのバイト数。

hPubKey

UINT_PTR

署名の認証に使用する public key のハンドル。この公開鍵は、その digital signature を作成する際に元々使用された key pair に属している必要があります。

szDescription

LPCSTR

inoptional

このパラメーターは今後使用すべきではなく、セキュリティ上の脆弱性を防ぐために NULL に設定する必要があります。ただし、Microsoft Base Cryptographic Provider では下位互換性のために引き続きサポートされています。

dwFlags

DWORD

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

値	意味
CRYPT_NOHASHOID 0x00000001	このフラグは RSA プロバイダーで使用されます。署名を検証する際に、ハッシュの object identifier (OID) が存在することやチェックされることを想定しません。このフラグが設定されていない場合、既定の署名内のハッシュ OID が、PKCS #7 の DigestInfo の定義に従って検証されます。
CRYPT_TYPE2_FORMAT 0x00000002	このフラグは使用されません。
CRYPT_X931_FORMAT 0x00000004	FIPS 186-2 準拠版の RSA (rDSA) に対して X.931 サポートを使用します。

戻り値の型: BOOL

公式ドキュメント

ハッシュオブジェクトの署名を検証します。(ANSI)

戻り値

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

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

"NTE" を接頭辞とするエラーコードは、使用している特定の CSP によって生成されます。発生し得るエラーコードの一部を次に示します。

戻りコード	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに有効でない値が含まれています。これは多くの場合、有効でないポインターです。
NTE_BAD_FLAGS	dwFlags パラメーターが 0 ではありません。
NTE_BAD_HASH	hHash パラメーターで指定されたハッシュオブジェクトが有効ではありません。
NTE_BAD_KEY	hPubKey パラメーターに有効な public key のハンドルが含まれていません。
NTE_BAD_SIGNATURE	署名が有効ではありませんでした。これは、データ自体が変更された、説明文字列が一致しなかった、または hPubKey で誤った公開鍵が指定されたことが原因である可能性があります。このエラーは、ハッシュアルゴリズムまたは署名アルゴリズムが、署名の作成に使用されたものと一致しない場合にも返されることがあります。
NTE_BAD_UID	ハッシュオブジェクトの作成時に指定された cryptographic service provider (CSP) コンテキストが見つかりません。
NTE_NO_MEMORY	操作中に CSP のメモリが不足しました。

解説(Remarks)

CryptVerifySignature 関数はハッシュを完了させます。この呼び出しの後は、ハッシュにそれ以上データを追加できません。 CryptHashData または CryptHashSessionKey をさらに呼び出すと失敗します。アプリケーションがハッシュの使用を終えたら、 CryptDestroyHash を呼び出してハッシュオブジェクトを破棄する必要があります。

.NET Framework API を使用して署名を生成し、それを CryptVerifySignature 関数で検証しようとすると、関数は失敗し、GetLastError は NTE_BAD_SIGNATURE を返します。これは、ネイティブの Win32 API と .NET Framework API でバイト順が異なるためです。

ネイティブの暗号化 API はリトルエンディアンのバイト順を使用し、.NET Framework API はビッグエンディアンのバイト順を使用します。.NET Framework API を使用して生成された署名を検証する場合は、CryptVerifySignature 関数を呼び出して署名を検証する前に、署名バイトの順序を入れ替える必要があります。

例

CryptVerifySignature 関数を使用する例については、Example C Program: Signing a Hash and Verifying the Hash Signature を参照してください。

メモ

wincrypt.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CryptVerifySignature を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptVerifySignatureA(
    UINT_PTR hHash,
    const BYTE* pbSignature,
    DWORD dwSigLen,
    UINT_PTR hPubKey,
    LPCSTR szDescription,   // optional
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CryptVerifySignatureA(
    UIntPtr hHash,   // UINT_PTR
    IntPtr pbSignature,   // BYTE*
    uint dwSigLen,   // DWORD
    UIntPtr hPubKey,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szDescription,   // LPCSTR optional
    uint dwFlags   // DWORD
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptVerifySignatureA(
    hHash As UIntPtr,   ' UINT_PTR
    pbSignature As IntPtr,   ' BYTE*
    dwSigLen As UInteger,   ' DWORD
    hPubKey As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> szDescription As String,   ' LPCSTR optional
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHash : UINT_PTR
' pbSignature : BYTE*
' dwSigLen : DWORD
' hPubKey : UINT_PTR
' szDescription : LPCSTR optional
' dwFlags : DWORD
Declare PtrSafe Function CryptVerifySignatureA Lib "advapi32" ( _
    ByVal hHash As LongPtr, _
    ByVal pbSignature As LongPtr, _
    ByVal dwSigLen As Long, _
    ByVal hPubKey As LongPtr, _
    ByVal szDescription As String, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptVerifySignatureA = ctypes.windll.advapi32.CryptVerifySignatureA
CryptVerifySignatureA.restype = wintypes.BOOL
CryptVerifySignatureA.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignature : BYTE*
    wintypes.DWORD,  # dwSigLen : DWORD
    ctypes.c_size_t,  # hPubKey : UINT_PTR
    wintypes.LPCSTR,  # szDescription : LPCSTR optional
    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')
CryptVerifySignatureA = Fiddle::Function.new(
  lib['CryptVerifySignatureA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pbSignature : BYTE*
    -Fiddle::TYPE_INT,  # dwSigLen : DWORD
    Fiddle::TYPE_UINTPTR_T,  # hPubKey : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szDescription : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CryptVerifySignatureA(UIntPtr hHash, IntPtr pbSignature, uint dwSigLen, UIntPtr hPubKey, [MarshalAs(UnmanagedType.LPStr)] string szDescription, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptVerifySignatureA' -Namespace Win32 -PassThru
# $api::CryptVerifySignatureA(hHash, pbSignature, dwSigLen, hPubKey, szDescription, dwFlags)

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

出力引数:

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