ホーム › Security.Cryptography › CryptSignMessageWithKey

CryptSignMessageWithKey

関数

CSP鍵を直接用いてメッセージに署名する。

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

シグネチャ

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

BOOL CryptSignMessageWithKey(
    CRYPT_KEY_SIGN_MESSAGE_PARA* pSignPara,
    const BYTE* pbToBeSigned,
    DWORD cbToBeSigned,
    BYTE* pbSignedBlob,   // optional
    DWORD* pcbSignedBlob
);

パラメーター

名前	型	方向	説明
pSignPara	CRYPT_KEY_SIGN_MESSAGE_PARA*	in	署名パラメーターを格納する CRYPT_KEY_SIGN_MESSAGE_PARA 構造体へのポインター。
pbToBeSigned	BYTE*	in	署名対象のメッセージを格納するバッファー配列へのポインター。
cbToBeSigned	DWORD	in	pbToBeSigned バッファー配列内の配列要素数。
pbSignedBlob	BYTE*	outoptional	エンコードされた署名済みメッセージを受け取るバッファーへのポインター。このパラメーターを NULL に設定すると、メモリ割り当てのためにこの情報のサイズを取得できます。詳細については、Retrieving Data of Unknown Length を参照してください。
pcbSignedBlob	DWORD*	inout	pbSignedBlob バッファーのサイズ (バイト単位) を示す DWORD 値へのポインター。関数が戻ると、この変数には署名およびエンコードされたメッセージのサイズ (バイト単位) が格納されます。 Note 返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には、可能な限り最大の出力データがバッファーに収まるよう、通常はバッファーサイズを十分大きく指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

パラメーターで指定された CSP の秘密キーを使用してメッセージに署名します。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

関数が失敗した場合、戻り値は 0 (FALSE) です。

拡張エラー情報を取得するには、GetLastError を呼び出します。

以下に、GetLastError 関数が返す最も一般的なエラーコードを示します。

戻りコード	説明
ERROR_MORE_DATA	pbSignedBlob パラメーターで指定されたバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbSignedBlob が指す変数に格納します。
E_INVALIDARG	メッセージエンコードの種類が無効です。現在サポートされているのは PKCS_7_ASN_ENCODING のみです。*pSignPara の cbSize が無効です。
CRYPT_E_NO_KEY_PROPERTY	*pSignPara の pSigningCert に CERT_KEY_PROV_INFO_PROP_ID プロパティまたは CERT_KEY_CONTEXT_PROP_ID プロパティがありません。

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

各言語での呼び出し定義

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

BOOL CryptSignMessageWithKey(
    CRYPT_KEY_SIGN_MESSAGE_PARA* pSignPara,
    const BYTE* pbToBeSigned,
    DWORD cbToBeSigned,
    BYTE* pbSignedBlob,   // optional
    DWORD* pcbSignedBlob
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSignMessageWithKey(
    IntPtr pSignPara,   // CRYPT_KEY_SIGN_MESSAGE_PARA*
    IntPtr pbToBeSigned,   // BYTE*
    uint cbToBeSigned,   // DWORD
    IntPtr pbSignedBlob,   // BYTE* optional, out
    ref uint pcbSignedBlob   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSignMessageWithKey(
    pSignPara As IntPtr,   ' CRYPT_KEY_SIGN_MESSAGE_PARA*
    pbToBeSigned As IntPtr,   ' BYTE*
    cbToBeSigned As UInteger,   ' DWORD
    pbSignedBlob As IntPtr,   ' BYTE* optional, out
    ByRef pcbSignedBlob As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA*
' pbToBeSigned : BYTE*
' cbToBeSigned : DWORD
' pbSignedBlob : BYTE* optional, out
' pcbSignedBlob : DWORD* in/out
Declare PtrSafe Function CryptSignMessageWithKey Lib "crypt32" ( _
    ByVal pSignPara As LongPtr, _
    ByVal pbToBeSigned As LongPtr, _
    ByVal cbToBeSigned As Long, _
    ByVal pbSignedBlob As LongPtr, _
    ByRef pcbSignedBlob As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptSignMessageWithKey = ctypes.windll.crypt32.CryptSignMessageWithKey
CryptSignMessageWithKey.restype = wintypes.BOOL
CryptSignMessageWithKey.argtypes = [
    ctypes.c_void_p,  # pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA*
    ctypes.POINTER(ctypes.c_ubyte),  # pbToBeSigned : BYTE*
    wintypes.DWORD,  # cbToBeSigned : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignedBlob : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbSignedBlob : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptSignMessageWithKey = Fiddle::Function.new(
  lib['CryptSignMessageWithKey'],
  [
    Fiddle::TYPE_VOIDP,  # pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA*
    Fiddle::TYPE_VOIDP,  # pbToBeSigned : BYTE*
    -Fiddle::TYPE_INT,  # cbToBeSigned : DWORD
    Fiddle::TYPE_VOIDP,  # pbSignedBlob : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbSignedBlob : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptSignMessageWithKey(
        pSignPara: *mut CRYPT_KEY_SIGN_MESSAGE_PARA,  // CRYPT_KEY_SIGN_MESSAGE_PARA*
        pbToBeSigned: *const u8,  // BYTE*
        cbToBeSigned: u32,  // DWORD
        pbSignedBlob: *mut u8,  // BYTE* optional, out
        pcbSignedBlob: *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 CryptSignMessageWithKey(IntPtr pSignPara, IntPtr pbToBeSigned, uint cbToBeSigned, IntPtr pbSignedBlob, ref uint pcbSignedBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptSignMessageWithKey' -Namespace Win32 -PassThru
# $api::CryptSignMessageWithKey(pSignPara, pbToBeSigned, cbToBeSigned, pbSignedBlob, pcbSignedBlob)

#uselib "CRYPT32.dll"
#func global CryptSignMessageWithKey "CryptSignMessageWithKey" sptr, sptr, sptr, sptr, sptr
; CryptSignMessageWithKey varptr(pSignPara), varptr(pbToBeSigned), cbToBeSigned, varptr(pbSignedBlob), varptr(pcbSignedBlob)   ; 戻り値は stat
; pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA* -> "sptr"
; pbToBeSigned : BYTE* -> "sptr"
; cbToBeSigned : DWORD -> "sptr"
; pbSignedBlob : BYTE* optional, out -> "sptr"
; pcbSignedBlob : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptSignMessageWithKey "CryptSignMessageWithKey" var, var, int, var, var
; res = CryptSignMessageWithKey(pSignPara, pbToBeSigned, cbToBeSigned, pbSignedBlob, pcbSignedBlob)
; pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA* -> "var"
; pbToBeSigned : BYTE* -> "var"
; cbToBeSigned : DWORD -> "int"
; pbSignedBlob : BYTE* optional, out -> "var"
; pcbSignedBlob : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptSignMessageWithKey "CryptSignMessageWithKey" sptr, sptr, int, sptr, sptr
; res = CryptSignMessageWithKey(varptr(pSignPara), varptr(pbToBeSigned), cbToBeSigned, varptr(pbSignedBlob), varptr(pcbSignedBlob))
; pSignPara : CRYPT_KEY_SIGN_MESSAGE_PARA* -> "sptr"
; pbToBeSigned : BYTE* -> "sptr"
; cbToBeSigned : DWORD -> "int"
; pbSignedBlob : BYTE* optional, out -> "sptr"
; pcbSignedBlob : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。