ホーム › Security.Cryptography › CryptSignHashW

CryptSignHashW

関数

ハッシュ値に秘密鍵でデジタル署名を行う(Unicode版)。

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptSignHashW(
    UINT_PTR hHash,
    DWORD dwKeySpec,
    LPCWSTR szDescription,   // optional
    DWORD dwFlags,
    BYTE* pbSignature,   // optional
    DWORD* pdwSigLen
);

パラメーター

名前

型

方向

説明

hHash

UINT_PTR

署名対象となるハッシュオブジェクトのハンドルです。

dwKeySpec

DWORD

プロバイダーのコンテナーから使用する秘密キーを指定します。AT_KEYEXCHANGE または AT_SIGNATURE を指定できます。

使用される署名アルゴリズムは、キーペアを最初に作成したときに指定されます。

Microsoft Base Cryptographic Provider がサポートする署名アルゴリズムは RSA Public Key アルゴリズムのみです。

szDescription

LPCWSTR

inoptional

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

dwFlags

DWORD

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

値	意味
CRYPT_NOHASHOID 0x00000001	RSA プロバイダーで使用します。ハッシュのオブジェクト識別子(OID)が RSA 公開キー暗号化に含められません。このフラグが設定されていない場合、既定の署名内のハッシュ OID は PKCS #1 の DigestInfo の定義に従ったものになります。
CRYPT_TYPE2_FORMAT 0x00000002	このフラグは使用されません。
CRYPT_X931_FORMAT 0x00000004	ANSI X9.31 標準で規定されている RSA 署名パディング方式を使用します。

pbSignature

BYTE*

outoptional

署名データを受け取るバッファーへのポインターです。

メモリ割り当ての目的でバッファーサイズを取得するために、このパラメーターに NULL を指定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。

pdwSigLen

DWORD*

inout

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

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

戻り値の型: BOOL

公式ドキュメント

データに署名します。(CryptSignHashW)

戻り値

関数が成功した場合は TRUE を返します。

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

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

戻り値	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに有効でない値が含まれています。多くの場合、これは有効でないポインターです。
ERROR_MORE_DATA	pbSignature パラメーターで指定されたバッファーが、返されるデータを保持するのに十分な大きさではありません。必要なバッファーサイズ(バイト単位)は pdwSigLen の DWORD 値に格納されます。
NTE_BAD_ALGID	hHash ハンドルがこの CSP でサポートされていないアルゴリズムを指定しているか、dwKeySpec パラメーターの値が正しくありません。
NTE_BAD_FLAGS	dwFlags パラメーターが 0 以外です。
NTE_BAD_HASH	hHash パラメーターで指定されたハッシュオブジェクトが有効ではありません。
NTE_BAD_UID	ハッシュオブジェクトの作成時に指定された CSP コンテキストが見つかりません。
NTE_NO_KEY	dwKeySpec で指定された秘密キーが存在しません。
NTE_NO_MEMORY	操作中に CSP のメモリが不足しました。

解説(Remarks)

この関数を呼び出す前に、 CryptCreateHash 関数を呼び出してハッシュオブジェクトのハンドルを取得する必要があります。次に、 CryptHashData または CryptHashSessionKey 関数を使用して、データまたはセッションキーをハッシュオブジェクトに追加します。CryptSignHash 関数はハッシュを完了させます。

DSS CSP は MD5 と SHA の両方のハッシュアルゴリズムによるハッシュ計算をサポートしますが、署名は SHA ハッシュに対してのみサポートします。

この関数を呼び出した後は、ハッシュにこれ以上データを追加できません。CryptHashData または CryptHashSessionKey を追加で呼び出すと失敗します。

アプリケーションがハッシュの使用を終えたら、CryptDestroyHash 関数を呼び出してハッシュオブジェクトを破棄します。

既定では、Microsoft RSA プロバイダーは署名に PKCS #1 パディング方式を使用します。署名の DigestInfo 要素内のハッシュ OID は、ハッシュオブジェクトに関連付けられたアルゴリズム OID に自動的に設定されます。CRYPT_NOHASHOID フラグを使用すると、この OID が署名から省略されます。

まれに、別の場所で生成されたハッシュ値に署名する必要がある場合があります。これは次の一連の操作で行えます。

CryptCreateHash を使用してハッシュオブジェクトを作成します。
CryptSetHashParam の dwParam パラメーターに HP_HASHVAL 値を使用して、ハッシュオブジェクトにハッシュ値を設定します。
CryptSignHash を使用してハッシュ値に署名し、デジタル署名ブロックを取得します。
CryptDestroyHash を使用してハッシュオブジェクトを破棄します。

例

次の例は、まず署名対象のデータをハッシュし、続いて CryptSignHash 関数を使用してそのハッシュに署名することで、データに署名する方法を示しています。

//-------------------------------------------------------------
// Declare and initialize variables.

HCRYPTPROV hProv;
BYTE *pbBuffer= (BYTE *)"Sample data that is to be signed.";
DWORD dwBufferLen = strlen((char *)pbBuffer)+1;
HCRYPTHASH hHash;

//--------------------------------------------------------------------
// This code assumes that a cryptographic context handle, hProv,
// and a hash handle, hHash, are available.
// For code needed to acquire the context, see "Example C Program: 
// Signing a Hash and Verifying the Hash Signature."

//--------------------------------------------------------------------
// Compute the cryptographic hash of the buffer.

if(CryptHashData(
   hHash, 
   pbBuffer, 
   dwBufferLen, 
   0)) 
{
     printf("The data buffer has been hashed.\n");
}
else
{
     printf("Error during CryptHashData.\n");
     exit(1);
}
//--------------------------------------------------------------------
// Determine the size of the signature and allocate memory.

dwSigLen= 0;
if(CryptSignHash(
   hHash, 
   AT_SIGNATURE, 
   szDescription, 
   0, 
   NULL, 
   &dwSigLen)) 
{
     printf("Signature length %d found.\n",dwSigLen);
}
else
{
     printf("Error during CryptSignHash\n");
     exit(1);
}
//--------------------------------------------------------------------
// Allocate memory for the signature buffer.

if(pbSignature = (BYTE *)malloc(dwSigLen))
{
     printf("Memory allocated for the signature.\n");
}
else
{
     printf("Out of memory\n");
     exit(1);
}
//--------------------------------------------------------------------
// Sign the hash object.

if(CryptSignHash(
   hHash, 
   AT_SIGNATURE, 
   szDescription, 
   0, 
   pbSignature, 
   &dwSigLen)) 
{
     printf("pbSignature is the hash signature.\n");
}
else
{
     printf("Error during CryptSignHash.\n");
     exit(1);
}
//--------------------------------------------------------------------
// Destroy the hash object.

if(hHash) 
  CryptDestroyHash(hHash);

このコードのコンテキストを含む完全な例については、 Example C Program: Signing a Hash and Verifying the Hash Signature を参照してください。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptSignHashW(
    UINT_PTR hHash,
    DWORD dwKeySpec,
    LPCWSTR szDescription,   // optional
    DWORD dwFlags,
    BYTE* pbSignature,   // optional
    DWORD* pdwSigLen
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CryptSignHashW(
    UIntPtr hHash,   // UINT_PTR
    uint dwKeySpec,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string szDescription,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    IntPtr pbSignature,   // BYTE* optional, out
    ref uint pdwSigLen   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSignHashW(
    hHash As UIntPtr,   ' UINT_PTR
    dwKeySpec As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szDescription As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    pbSignature As IntPtr,   ' BYTE* optional, out
    ByRef pdwSigLen As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHash : UINT_PTR
' dwKeySpec : DWORD
' szDescription : LPCWSTR optional
' dwFlags : DWORD
' pbSignature : BYTE* optional, out
' pdwSigLen : DWORD* in/out
Declare PtrSafe Function CryptSignHashW Lib "advapi32" ( _
    ByVal hHash As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByVal szDescription As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbSignature As LongPtr, _
    ByRef pdwSigLen As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptSignHashW = ctypes.windll.advapi32.CryptSignHashW
CryptSignHashW.restype = wintypes.BOOL
CryptSignHashW.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
    wintypes.DWORD,  # dwKeySpec : DWORD
    wintypes.LPCWSTR,  # szDescription : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignature : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSigLen : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptSignHashW = Fiddle::Function.new(
  lib['CryptSignHashW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
    -Fiddle::TYPE_INT,  # dwKeySpec : DWORD
    Fiddle::TYPE_VOIDP,  # szDescription : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbSignature : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pdwSigLen : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CryptSignHashW(
        hHash: usize,  // UINT_PTR
        dwKeySpec: u32,  // DWORD
        szDescription: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        pbSignature: *mut u8,  // BYTE* optional, out
        pdwSigLen: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CryptSignHashW(UIntPtr hHash, uint dwKeySpec, [MarshalAs(UnmanagedType.LPWStr)] string szDescription, uint dwFlags, IntPtr pbSignature, ref uint pdwSigLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSignHashW' -Namespace Win32 -PassThru
# $api::CryptSignHashW(hHash, dwKeySpec, szDescription, dwFlags, pbSignature, pdwSigLen)

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

出力引数:

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