ホーム › Security.Cryptography › NCryptSignHash

NCryptSignHash

関数

指定したキーでハッシュ値に署名する。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptSignHash(
    NCRYPT_KEY_HANDLE hKey,
    void* pPaddingInfo,   // optional
    BYTE* pbHashValue,
    DWORD cbHashValue,
    BYTE* pbSignature,   // optional
    DWORD cbSignature,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前型方向説明

hKey NCRYPT_KEY_HANDLE in 署名の生成に使用する秘密鍵のハンドル。

pPaddingInfo void* inoptional パディング情報を含む構造体へのポインター。このパラメーターが指す構造体の実際の型は、dwFlags パラメーターの値によって異なります。dwFlags が 0 の場合、このパラメーターは NULL でなければなりません。

pbHashValue

BYTE*

署名対象の入力を含むバッファーへのポインター。このバッファーのサイズは cbHashValue パラメーターに格納されます。

注: パラメーター名 pbHashValue は、この API の経緯により実態に即していない名称です。

多くの署名アルゴリズム(DSA、RSA、ECDSA、HashML-DSA など)では、署名ルーチンはハッシュ関数の結果を入力として受け取るよう定義されています。これらのアルゴリズムでは、署名対象の元のメッセージをまずハッシュ化し、その結果として得られるハッシュ値(プリハッシュ)を pbHashValue バッファーに渡します。

ただし、一部の署名アルゴリズム(純粋な ML-DSA、純粋な SLH-DSA など)では、任意サイズのデータを直接署名できます。これらのアルゴリズムでは、pbHashValue バッファーには署名対象の入力が格納されます。署名者と検証者はこの入力の構成方法について合意する必要がありますが、プリハッシュを介在させる必要はありません。非常に大きなバッファーを直接署名すると、相互運用性を損なう場合があります。

いずれの場合も、pbHashValue バッファーは署名対象の入力を表します。

cbHashValue DWORD in pbHashValue バッファーのサイズ(バイト単位)。

pbSignature

BYTE*

outoptional

この関数によって生成される署名を受け取るバッファーのアドレス。このバッファーのサイズは cbSignature パラメーターに格納されます。

このパラメーターが NULL の場合、この関数は署名に必要なサイズを計算し、そのサイズを pcbResult パラメーターが指す場所に返します。

cbSignature DWORD in pbSignature バッファーのサイズ(バイト単位)。pbSignature パラメーターが NULL の場合、このパラメーターは無視されます。

pcbResult

DWORD*

out

pbSignature バッファーにコピーされたバイト数を受け取る DWORD 変数へのポインター。

pbSignature が NULL の場合、署名に必要なサイズ(バイト単位)を受け取ります。

dwFlags

NCRYPT_FLAGS

この関数の動作を変更するフラグのセット。指定できるフラグのセットは、hKey パラメーターで指定された鍵の種類によって異なります。

ゼロ、または次の値のうち 1 つ以上を組み合わせて指定できます。

値	意味
NCRYPT_PAD_PKCS1_FLAG	RSA PKCS1 パディング方式を使用します。pPaddingInfo パラメーターは BCRYPT_PKCS1_PADDING_INFO 構造体へのポインターです。
NCRYPT_PAD_PSS_FLAG	RSA 確率的署名方式(PSS)パディング方式を使用します。pPaddingInfo パラメーターは BCRYPT_PSS_PADDING_INFO 構造体へのポインターです。
NCRYPT_PAD_PQDSA_FLAG	ML-DSA または SLH-DSA 用の PQ パディング方式を使用します。pPaddingInfo パラメーターは BCRYPT_PQDSA_PADDING_INFO 構造体へのポインターです。注: プリハッシュ ML-DSA バリアントを使用する場合は、これを設定する必要があります。
NCRYPT_SILENT_FLAG	鍵ストレージプロバイダー(KSP)がユーザーインターフェイスを表示しないように要求します。プロバイダーが動作するために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

ハッシュ値の署名を作成します。(NCryptSignHash)

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_ALGID	hKey パラメーターで表される鍵は署名をサポートしていません。
NTE_BAD_FLAGS	dwFlags パラメーターに無効な値が含まれています。
NTE_INVALID_HANDLE	hKey パラメーターが無効です。
NTE_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY	メモリ割り当てエラーが発生しました。

解説(Remarks)

サービスは、この関数を StartService 関数から呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する場合があります。

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

各言語での呼び出し定義

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

HRESULT NCryptSignHash(
    NCRYPT_KEY_HANDLE hKey,
    void* pPaddingInfo,   // optional
    BYTE* pbHashValue,
    DWORD cbHashValue,
    BYTE* pbSignature,   // optional
    DWORD cbSignature,
    DWORD* pcbResult,
    NCRYPT_FLAGS dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptSignHash(
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    IntPtr pPaddingInfo,   // void* optional
    IntPtr pbHashValue,   // BYTE*
    uint cbHashValue,   // DWORD
    IntPtr pbSignature,   // BYTE* optional, out
    uint cbSignature,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // NCRYPT_FLAGS
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptSignHash(
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    pPaddingInfo As IntPtr,   ' void* optional
    pbHashValue As IntPtr,   ' BYTE*
    cbHashValue As UInteger,   ' DWORD
    pbSignature As IntPtr,   ' BYTE* optional, out
    cbSignature As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function

' hKey : NCRYPT_KEY_HANDLE
' pPaddingInfo : void* optional
' pbHashValue : BYTE*
' cbHashValue : DWORD
' pbSignature : BYTE* optional, out
' cbSignature : DWORD
' pcbResult : DWORD* out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptSignHash Lib "ncrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal pPaddingInfo As LongPtr, _
    ByVal pbHashValue As LongPtr, _
    ByVal cbHashValue As Long, _
    ByVal pbSignature As LongPtr, _
    ByVal cbSignature As Long, _
    ByRef pcbResult As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptSignHash = ctypes.windll.ncrypt.NCryptSignHash
NCryptSignHash.restype = ctypes.c_int
NCryptSignHash.argtypes = [
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    ctypes.POINTER(None),  # pPaddingInfo : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbHashValue : BYTE*
    wintypes.DWORD,  # cbHashValue : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignature : BYTE* optional, out
    wintypes.DWORD,  # cbSignature : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptSignHash = Fiddle::Function.new(
  lib['NCryptSignHash'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # pPaddingInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pbHashValue : BYTE*
    -Fiddle::TYPE_INT,  # cbHashValue : DWORD
    Fiddle::TYPE_VOIDP,  # pbSignature : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbSignature : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptSignHash(
        hKey: usize,  // NCRYPT_KEY_HANDLE
        pPaddingInfo: *mut (),  // void* optional
        pbHashValue: *mut u8,  // BYTE*
        cbHashValue: u32,  // DWORD
        pbSignature: *mut u8,  // BYTE* optional, out
        cbSignature: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // NCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptSignHash(UIntPtr hKey, IntPtr pPaddingInfo, IntPtr pbHashValue, uint cbHashValue, IntPtr pbSignature, uint cbSignature, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptSignHash' -Namespace Win32 -PassThru
# $api::NCryptSignHash(hKey, pPaddingInfo, pbHashValue, cbHashValue, pbSignature, cbSignature, pcbResult, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptSignHash "NCryptSignHash" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NCryptSignHash hKey, pPaddingInfo, varptr(pbHashValue), cbHashValue, varptr(pbSignature), cbSignature, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbHashValue : BYTE* -> "sptr"
; cbHashValue : DWORD -> "sptr"
; pbSignature : BYTE* optional, out -> "sptr"
; cbSignature : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptSignHash "NCryptSignHash" sptr, sptr, var, int, var, int, var, int
; res = NCryptSignHash(hKey, pPaddingInfo, pbHashValue, cbHashValue, pbSignature, cbSignature, pcbResult, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbHashValue : BYTE* -> "var"
; cbHashValue : DWORD -> "int"
; pbSignature : BYTE* optional, out -> "var"
; cbSignature : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptSignHash "NCryptSignHash" sptr, sptr, sptr, int, sptr, int, sptr, int
; res = NCryptSignHash(hKey, pPaddingInfo, varptr(pbHashValue), cbHashValue, varptr(pbSignature), cbSignature, varptr(pcbResult), dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbHashValue : BYTE* -> "sptr"
; cbHashValue : DWORD -> "int"
; pbSignature : BYTE* optional, out -> "sptr"
; cbSignature : DWORD -> "int"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。