ホーム › Security.Cryptography › CryptSignMessage

CryptSignMessage

関数

データに署名してPKCS#7署名付きメッセージを生成する。

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

シグネチャ

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

BOOL CryptSignMessage(
    CRYPT_SIGN_MESSAGE_PARA* pSignPara,
    BOOL fDetachedSignature,
    DWORD cToBeSigned,
    const BYTE** rgpbToBeSigned,   // optional
    DWORD* rgcbToBeSigned,
    BYTE* pbSignedBlob,   // optional
    DWORD* pcbSignedBlob
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

CryptSignMessage 関数は、指定されたコンテンツのハッシュを作成し、そのハッシュに署名した後、元のメッセージコンテンツと署名済みハッシュの両方をエンコードします。

戻り値

関数が成功すると、戻り値は 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 プロパティがありません。

注意呼び出される関数 CryptCreateHash、 CryptHashData、 CryptSignHash からのエラーが、この関数に伝播される場合があります。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One(ASN.1)のエンコード/デコードエラーを返すことがあります。これらのエラーの詳細については、 ASN.1 Encoding/Decoding Return Values を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptSignMessage(
    CRYPT_SIGN_MESSAGE_PARA* pSignPara,
    BOOL fDetachedSignature,
    DWORD cToBeSigned,
    const BYTE** rgpbToBeSigned,   // optional
    DWORD* rgcbToBeSigned,
    BYTE* pbSignedBlob,   // optional
    DWORD* pcbSignedBlob
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSignMessage(
    IntPtr pSignPara,   // CRYPT_SIGN_MESSAGE_PARA*
    bool fDetachedSignature,   // BOOL
    uint cToBeSigned,   // DWORD
    IntPtr rgpbToBeSigned,   // BYTE** optional
    ref uint rgcbToBeSigned,   // DWORD*
    IntPtr pbSignedBlob,   // BYTE* optional, out
    ref uint pcbSignedBlob   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSignMessage(
    pSignPara As IntPtr,   ' CRYPT_SIGN_MESSAGE_PARA*
    fDetachedSignature As Boolean,   ' BOOL
    cToBeSigned As UInteger,   ' DWORD
    rgpbToBeSigned As IntPtr,   ' BYTE** optional
    ByRef rgcbToBeSigned 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_SIGN_MESSAGE_PARA*
' fDetachedSignature : BOOL
' cToBeSigned : DWORD
' rgpbToBeSigned : BYTE** optional
' rgcbToBeSigned : DWORD*
' pbSignedBlob : BYTE* optional, out
' pcbSignedBlob : DWORD* in/out
Declare PtrSafe Function CryptSignMessage Lib "crypt32" ( _
    ByVal pSignPara As LongPtr, _
    ByVal fDetachedSignature As Long, _
    ByVal cToBeSigned As Long, _
    ByVal rgpbToBeSigned As LongPtr, _
    ByRef rgcbToBeSigned 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

CryptSignMessage = ctypes.windll.crypt32.CryptSignMessage
CryptSignMessage.restype = wintypes.BOOL
CryptSignMessage.argtypes = [
    ctypes.c_void_p,  # pSignPara : CRYPT_SIGN_MESSAGE_PARA*
    wintypes.BOOL,  # fDetachedSignature : BOOL
    wintypes.DWORD,  # cToBeSigned : DWORD
    ctypes.c_void_p,  # rgpbToBeSigned : BYTE** optional
    ctypes.POINTER(wintypes.DWORD),  # rgcbToBeSigned : 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')
CryptSignMessage = Fiddle::Function.new(
  lib['CryptSignMessage'],
  [
    Fiddle::TYPE_VOIDP,  # pSignPara : CRYPT_SIGN_MESSAGE_PARA*
    Fiddle::TYPE_INT,  # fDetachedSignature : BOOL
    -Fiddle::TYPE_INT,  # cToBeSigned : DWORD
    Fiddle::TYPE_VOIDP,  # rgpbToBeSigned : BYTE** optional
    Fiddle::TYPE_VOIDP,  # rgcbToBeSigned : DWORD*
    Fiddle::TYPE_VOIDP,  # pbSignedBlob : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbSignedBlob : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptSignMessage(
        pSignPara: *mut CRYPT_SIGN_MESSAGE_PARA,  // CRYPT_SIGN_MESSAGE_PARA*
        fDetachedSignature: i32,  // BOOL
        cToBeSigned: u32,  // DWORD
        rgpbToBeSigned: *const *const u8,  // BYTE** optional
        rgcbToBeSigned: *mut 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 CryptSignMessage(IntPtr pSignPara, bool fDetachedSignature, uint cToBeSigned, IntPtr rgpbToBeSigned, ref uint rgcbToBeSigned, IntPtr pbSignedBlob, ref uint pcbSignedBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptSignMessage' -Namespace Win32 -PassThru
# $api::CryptSignMessage(pSignPara, fDetachedSignature, cToBeSigned, rgpbToBeSigned, rgcbToBeSigned, pbSignedBlob, pcbSignedBlob)

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

出力引数:

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