ホーム › Security.Cryptography › BCryptSignHash

BCryptSignHash

関数

CNGの秘密鍵でハッシュにデジタル署名を行う。

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

シグネチャ

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

NTSTATUS BCryptSignHash(
    BCRYPT_KEY_HANDLE hKey,
    void* pPaddingInfo,   // optional
    BYTE* pbInput,
    DWORD cbInput,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    BCRYPT_FLAGS dwFlags
);

パラメーター

名前型方向説明

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

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

pbInput

BYTE*

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

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

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

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

cbInput DWORD in pbInput バッファーのサイズ(バイト単位)です。

pbOutput

BYTE*

outoptional

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

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

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

pcbResult

DWORD*

out

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

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

dwFlags

BCRYPT_FLAGS

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

これには、ゼロまたは次のいずれかの値を指定できます。

値	意味
BCRYPT_PAD_PKCS1	RSA PKCS1 署名パディング方式を使用します。pPaddingInfo パラメーターは BCRYPT_PKCS1_PADDING_INFO 構造体へのポインターです。
BCRYPT_PAD_PSS	RSA 確率的署名方式(PSS)パディング方式を使用します。pPaddingInfo パラメーターは BCRYPT_PSS_PADDING_INFO 構造体へのポインターです。
BCRYPT_PAD_PQDSA	ポスト量子デジタル署名アルゴリズム(PQDSA)署名の計算方法に関する追加情報を提供します。pPaddingInfo パラメーターは BCRYPT_PQDSA_PADDING_INFO 構造体へのポインターです。注: プリハッシュ PQDSA バリアントを使用する場合は、これを設定する必要があります。 Windows Insiders (build 27843): PQDSA のサポートが開始されます。

戻り値の型: NTSTATUS

公式ドキュメント

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

戻り値

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

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

戻り値	説明
STATUS_SUCCESS	関数は成功しました。
STATUS_INVALID_PARAMETER	指定されたパラメーターの 1 つが無効です。
STATUS_INVALID_HANDLE	hKey パラメーターで指定された鍵ハンドルが無効です。
STATUS_NO_MEMORY	メモリの割り当てに失敗しました。
STATUS_NOT_SUPPORTED	hKey パラメーターで指定された鍵ハンドルの作成に使用されたアルゴリズムプロバイダーが署名アルゴリズムではありません。
STATUS_BUFFER_TOO_SMALL	cbOutput パラメーターで指定されたメモリサイズが署名を保持するのに十分ではありません。

解説(Remarks)

この関数は、デジタル署名方式の署名操作を実行します。署名対象のデータと秘密鍵を受け取り、dwFlags および pPaddingInfo で必要に応じて指定される追加パラメーターとともに、対応する公開鍵で後から検証できる署名を生成します。

署名が有効であることを後で検証するには、提供された秘密鍵に対応する公開鍵を含む鍵と、検証対象の同一のデータを使用して BCryptVerifySignature 関数を呼び出します。

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptSignHash はユーザーモードまたはカーネルモードのいずれからでも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、hKey パラメーターで指定されるハンドルは、BCRYPT_PROV_DISPATCH フラグを指定して開かれたプロバイダーによって返されたアルゴリズムハンドルから派生したものでなければならず、BCryptSignHash 関数に渡されるポインターはすべて、ノンページド(またはロックされた)メモリを参照する必要があります。

この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) の一部である Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。

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

各言語での呼び出し定義

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

NTSTATUS BCryptSignHash(
    BCRYPT_KEY_HANDLE hKey,
    void* pPaddingInfo,   // optional
    BYTE* pbInput,
    DWORD cbInput,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    BCRYPT_FLAGS dwFlags
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptSignHash(
    IntPtr hKey,   // BCRYPT_KEY_HANDLE
    IntPtr pPaddingInfo,   // void* optional
    IntPtr pbInput,   // BYTE*
    uint cbInput,   // DWORD
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // BCRYPT_FLAGS
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptSignHash(
    hKey As IntPtr,   ' BCRYPT_KEY_HANDLE
    pPaddingInfo As IntPtr,   ' void* optional
    pbInput As IntPtr,   ' BYTE*
    cbInput As UInteger,   ' DWORD
    pbOutput As IntPtr,   ' BYTE* optional, out
    cbOutput As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' BCRYPT_FLAGS
) As Integer
End Function

' hKey : BCRYPT_KEY_HANDLE
' pPaddingInfo : void* optional
' pbInput : BYTE*
' cbInput : DWORD
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : BCRYPT_FLAGS
Declare PtrSafe Function BCryptSignHash Lib "bcrypt" ( _
    ByVal hKey As LongPtr, _
    ByVal pPaddingInfo As LongPtr, _
    ByVal pbInput As LongPtr, _
    ByVal cbInput As Long, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput 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

BCryptSignHash = ctypes.windll.bcrypt.BCryptSignHash
BCryptSignHash.restype = ctypes.c_int
BCryptSignHash.argtypes = [
    wintypes.HANDLE,  # hKey : BCRYPT_KEY_HANDLE
    ctypes.POINTER(None),  # pPaddingInfo : void* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbInput : BYTE*
    wintypes.DWORD,  # cbInput : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    wintypes.DWORD,  # cbOutput : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : BCRYPT_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptSignHash = Fiddle::Function.new(
  lib['BCryptSignHash'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : BCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # pPaddingInfo : void* optional
    Fiddle::TYPE_VOIDP,  # pbInput : BYTE*
    -Fiddle::TYPE_INT,  # cbInput : DWORD
    Fiddle::TYPE_VOIDP,  # pbOutput : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbOutput : DWORD
    Fiddle::TYPE_VOIDP,  # pcbResult : DWORD* out
    -Fiddle::TYPE_INT,  # dwFlags : BCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "bcrypt")]
extern "system" {
    fn BCryptSignHash(
        hKey: *mut core::ffi::c_void,  // BCRYPT_KEY_HANDLE
        pPaddingInfo: *mut (),  // void* optional
        pbInput: *mut u8,  // BYTE*
        cbInput: u32,  // DWORD
        pbOutput: *mut u8,  // BYTE* optional, out
        cbOutput: u32,  // DWORD
        pcbResult: *mut u32,  // DWORD* out
        dwFlags: u32  // BCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptSignHash(IntPtr hKey, IntPtr pPaddingInfo, IntPtr pbInput, uint cbInput, IntPtr pbOutput, uint cbOutput, out uint pcbResult, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptSignHash' -Namespace Win32 -PassThru
# $api::BCryptSignHash(hKey, pPaddingInfo, pbInput, cbInput, pbOutput, cbOutput, pcbResult, dwFlags)

#uselib "bcrypt.dll"
#func global BCryptSignHash "BCryptSignHash" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; BCryptSignHash hKey, pPaddingInfo, varptr(pbInput), cbInput, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags   ; 戻り値は stat
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbInput : BYTE* -> "sptr"
; cbInput : DWORD -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "sptr"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : BCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "bcrypt.dll"
#cfunc global BCryptSignHash "BCryptSignHash" sptr, sptr, var, int, var, int, var, int
; res = BCryptSignHash(hKey, pPaddingInfo, pbInput, cbInput, pbOutput, cbOutput, pcbResult, dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbInput : BYTE* -> "var"
; cbInput : DWORD -> "int"
; pbOutput : BYTE* optional, out -> "var"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "var"
; dwFlags : BCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll"
#cfunc global BCryptSignHash "BCryptSignHash" sptr, sptr, sptr, int, sptr, int, sptr, int
; res = BCryptSignHash(hKey, pPaddingInfo, varptr(pbInput), cbInput, varptr(pbOutput), cbOutput, varptr(pcbResult), dwFlags)
; hKey : BCRYPT_KEY_HANDLE -> "sptr"
; pPaddingInfo : void* optional -> "sptr"
; pbInput : BYTE* -> "sptr"
; cbInput : DWORD -> "int"
; pbOutput : BYTE* optional, out -> "sptr"
; cbOutput : DWORD -> "int"
; pcbResult : DWORD* out -> "sptr"
; dwFlags : BCRYPT_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。