ホーム › Security.Cryptography › CryptMsgEncodeAndSignCTL

CryptMsgEncodeAndSignCTL

関数

CTL情報をエンコードして署名済みメッセージを生成する。

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

シグネチャ

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

BOOL CryptMsgEncodeAndSignCTL(
    DWORD dwMsgEncodingType,
    CTL_INFO* pCtlInfo,
    CMSG_SIGNED_ENCODE_INFO* pSignInfo,
    DWORD dwFlags,
    BYTE* pbEncoded,   // optional
    DWORD* pcbEncoded
);

パラメーター

名前	型	方向	説明
dwMsgEncodingType	DWORD	in	使用するエンコードの種類を指定します。次の例に示すように、証明書のエンコードの種類とメッセージのエンコードの種類の両方をビットごとの論理和(OR)演算で組み合わせて指定することは常に有効です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコードの種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pCtlInfo	CTL_INFO*	in	エンコードおよび署名対象の CTL を含む CTL_INFO 構造体へのポインターです。
pSignInfo	CMSG_SIGNED_ENCODE_INFO*	in	CMSG_SIGNER_ENCODE_INFO 構造体の配列を含む CMSG_SIGNED_ENCODE_INFO 構造体へのポインターです。構造体の cbSize メンバーに構造体のサイズを設定し、その他のすべてのメンバーをゼロに設定すると、署名者なしでメッセージをエンコードできます。
dwFlags	DWORD	in	エンコード前に CTL エントリを並べ替える場合は CMSG_ENCODE_SORTED_CTL_FLAG を設定します。このフラグは、 CertFindSubjectInSortedCTL 関数または CertEnumSubjectInSortedCTL 関数を呼び出す場合に設定します。 CMSG_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG は、CMSG_ENCODE_SORTED_CTL_FLAG が設定されており、かつ TrustedSubjects の識別子が MD5 や SHA1 などのハッシュである場合に設定します。 CMS_PKCS7 が定義されている場合、CMS 互換の V3 SignedData メッセージをエンコードするために、dwFlags に CMSG_CMS_ENCAPSULATED_CTL_FLAG を設定できます。
pbEncoded	BYTE*	outoptional	作成された、エンコード済みかつ署名済みのメッセージを受け取るバッファーへのポインターです。このパラメーターは、メモリ割り当てを目的としてこの情報のサイズを設定するために NULL にすることができます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbEncoded	DWORD*	inout	pbEncoded バッファーのサイズ(バイト単位)を指定する DWORD へのポインターです。関数が戻るとき、この DWORD にはバッファーに格納された、または格納されるバイト数が入ります。

戻り値の型: BOOL

公式ドキュメント

CryptMsgEncodeAndSignCTL 関数は、CTL をエンコードし、エンコードされた CTL を含む署名付きメッセージを作成します。この関数は、まず pCtlInfo が指す CTL をエンコードし、続いて CryptMsgSignCTL を呼び出してエンコード済みメッセージに署名します。

戻り値

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

関数が失敗した場合、戻り値は 0(FALSE)です。拡張エラー情報を取得するには、 GetLastError を呼び出します。エラーは CryptMsgOpenToEncode および CryptMsgUpdate の呼び出しから伝播することがあります。

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

各言語での呼び出し定義

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

BOOL CryptMsgEncodeAndSignCTL(
    DWORD dwMsgEncodingType,
    CTL_INFO* pCtlInfo,
    CMSG_SIGNED_ENCODE_INFO* pSignInfo,
    DWORD dwFlags,
    BYTE* pbEncoded,   // optional
    DWORD* pcbEncoded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptMsgEncodeAndSignCTL(
    uint dwMsgEncodingType,   // DWORD
    IntPtr pCtlInfo,   // CTL_INFO*
    IntPtr pSignInfo,   // CMSG_SIGNED_ENCODE_INFO*
    uint dwFlags,   // DWORD
    IntPtr pbEncoded,   // BYTE* optional, out
    ref uint pcbEncoded   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptMsgEncodeAndSignCTL(
    dwMsgEncodingType As UInteger,   ' DWORD
    pCtlInfo As IntPtr,   ' CTL_INFO*
    pSignInfo As IntPtr,   ' CMSG_SIGNED_ENCODE_INFO*
    dwFlags As UInteger,   ' DWORD
    pbEncoded As IntPtr,   ' BYTE* optional, out
    ByRef pcbEncoded As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwMsgEncodingType : DWORD
' pCtlInfo : CTL_INFO*
' pSignInfo : CMSG_SIGNED_ENCODE_INFO*
' dwFlags : DWORD
' pbEncoded : BYTE* optional, out
' pcbEncoded : DWORD* in/out
Declare PtrSafe Function CryptMsgEncodeAndSignCTL Lib "crypt32" ( _
    ByVal dwMsgEncodingType As Long, _
    ByVal pCtlInfo As LongPtr, _
    ByVal pSignInfo As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbEncoded As LongPtr, _
    ByRef pcbEncoded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptMsgEncodeAndSignCTL = ctypes.windll.crypt32.CryptMsgEncodeAndSignCTL
CryptMsgEncodeAndSignCTL.restype = wintypes.BOOL
CryptMsgEncodeAndSignCTL.argtypes = [
    wintypes.DWORD,  # dwMsgEncodingType : DWORD
    ctypes.c_void_p,  # pCtlInfo : CTL_INFO*
    ctypes.c_void_p,  # pSignInfo : CMSG_SIGNED_ENCODE_INFO*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncoded : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbEncoded : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptMsgEncodeAndSignCTL = Fiddle::Function.new(
  lib['CryptMsgEncodeAndSignCTL'],
  [
    -Fiddle::TYPE_INT,  # dwMsgEncodingType : DWORD
    Fiddle::TYPE_VOIDP,  # pCtlInfo : CTL_INFO*
    Fiddle::TYPE_VOIDP,  # pSignInfo : CMSG_SIGNED_ENCODE_INFO*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbEncoded : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbEncoded : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptMsgEncodeAndSignCTL(
        dwMsgEncodingType: u32,  // DWORD
        pCtlInfo: *mut CTL_INFO,  // CTL_INFO*
        pSignInfo: *mut CMSG_SIGNED_ENCODE_INFO,  // CMSG_SIGNED_ENCODE_INFO*
        dwFlags: u32,  // DWORD
        pbEncoded: *mut u8,  // BYTE* optional, out
        pcbEncoded: *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 CryptMsgEncodeAndSignCTL(uint dwMsgEncodingType, IntPtr pCtlInfo, IntPtr pSignInfo, uint dwFlags, IntPtr pbEncoded, ref uint pcbEncoded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptMsgEncodeAndSignCTL' -Namespace Win32 -PassThru
# $api::CryptMsgEncodeAndSignCTL(dwMsgEncodingType, pCtlInfo, pSignInfo, dwFlags, pbEncoded, pcbEncoded)

#uselib "CRYPT32.dll"
#func global CryptMsgEncodeAndSignCTL "CryptMsgEncodeAndSignCTL" sptr, sptr, sptr, sptr, sptr, sptr
; CryptMsgEncodeAndSignCTL dwMsgEncodingType, varptr(pCtlInfo), varptr(pSignInfo), dwFlags, varptr(pbEncoded), varptr(pcbEncoded)   ; 戻り値は stat
; dwMsgEncodingType : DWORD -> "sptr"
; pCtlInfo : CTL_INFO* -> "sptr"
; pSignInfo : CMSG_SIGNED_ENCODE_INFO* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbEncoded : BYTE* optional, out -> "sptr"
; pcbEncoded : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptMsgEncodeAndSignCTL "CryptMsgEncodeAndSignCTL" int, var, var, int, var, var
; res = CryptMsgEncodeAndSignCTL(dwMsgEncodingType, pCtlInfo, pSignInfo, dwFlags, pbEncoded, pcbEncoded)
; dwMsgEncodingType : DWORD -> "int"
; pCtlInfo : CTL_INFO* -> "var"
; pSignInfo : CMSG_SIGNED_ENCODE_INFO* -> "var"
; dwFlags : DWORD -> "int"
; pbEncoded : BYTE* optional, out -> "var"
; pcbEncoded : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptMsgEncodeAndSignCTL "CryptMsgEncodeAndSignCTL" int, sptr, sptr, int, sptr, sptr
; res = CryptMsgEncodeAndSignCTL(dwMsgEncodingType, varptr(pCtlInfo), varptr(pSignInfo), dwFlags, varptr(pbEncoded), varptr(pcbEncoded))
; dwMsgEncodingType : DWORD -> "int"
; pCtlInfo : CTL_INFO* -> "sptr"
; pSignInfo : CMSG_SIGNED_ENCODE_INFO* -> "sptr"
; dwFlags : DWORD -> "int"
; pbEncoded : BYTE* optional, out -> "sptr"
; pcbEncoded : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。