ホーム › Security.Cryptography › CryptMsgCountersignEncoded

CryptMsgCountersignEncoded

関数

エンコードされた署名者情報に副署名を付与する。

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

シグネチャ

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

BOOL CryptMsgCountersignEncoded(
    DWORD dwEncodingType,
    BYTE* pbSignerInfo,
    DWORD cbSignerInfo,
    DWORD cCountersigners,
    CMSG_SIGNER_ENCODE_INFO* rgCountersigners,
    BYTE* pbCountersignature,   // optional
    DWORD* pcbCountersignature
);

パラメーター

名前	型	方向	説明
dwEncodingType	DWORD	in	使用するエンコード方式を指定します。現在使用されるのは X509_ASN_ENCODING と PKCS_7_ASN_ENCODING のみですが、将来追加のエンコード方式が追加される可能性があります。現在のどちらのエンコード方式でも、次を使用します。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING。
pbSignerInfo	BYTE*	in	副署対象となるエンコード済み SignerInfo へのポインター。
cbSignerInfo	DWORD	in	エンコード済み SignerInfo データのバイト数。
cCountersigners	DWORD	in	rgCountersigners 配列内の副署者の数。
rgCountersigners	CMSG_SIGNER_ENCODE_INFO*	in	副署者の CMSG_SIGNER_ENCODE_INFO 構造体の配列。
pbCountersignature	BYTE*	outoptional	エンコード済みの PKCS #9 countersignature 属性を受け取るバッファーへのポインター。入力時、このパラメーターを NULL にして、メモリ割り当てのためにこの情報のサイズを取得することができます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbCountersignature	DWORD*	inout	pbCountersignature パラメーターが指すバッファーのサイズ (バイト単位) を指定する変数へのポインター。関数が戻るとき、pcbCountersignature パラメーターが指す変数には、バッファーに格納されたバイト数が含まれます。

戻り値の型: BOOL

公式ドキュメント

既存の PKCS に副署 (countersign) します。

戻り値

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

関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

戻りコード	説明
CRYPT_E_OID_FORMAT	オブジェクト識別子の形式が正しくありません。
E_INVALIDARG	1 つ以上の引数が無効です。
E_OUTOFMEMORY	メモリが不足しました。

次のいずれかの関数から伝播されたエラーが返される場合があります。

関数が失敗した場合、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 CryptMsgCountersignEncoded(
    DWORD dwEncodingType,
    BYTE* pbSignerInfo,
    DWORD cbSignerInfo,
    DWORD cCountersigners,
    CMSG_SIGNER_ENCODE_INFO* rgCountersigners,
    BYTE* pbCountersignature,   // optional
    DWORD* pcbCountersignature
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptMsgCountersignEncoded(
    uint dwEncodingType,   // DWORD
    IntPtr pbSignerInfo,   // BYTE*
    uint cbSignerInfo,   // DWORD
    uint cCountersigners,   // DWORD
    IntPtr rgCountersigners,   // CMSG_SIGNER_ENCODE_INFO*
    IntPtr pbCountersignature,   // BYTE* optional, out
    ref uint pcbCountersignature   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptMsgCountersignEncoded(
    dwEncodingType As UInteger,   ' DWORD
    pbSignerInfo As IntPtr,   ' BYTE*
    cbSignerInfo As UInteger,   ' DWORD
    cCountersigners As UInteger,   ' DWORD
    rgCountersigners As IntPtr,   ' CMSG_SIGNER_ENCODE_INFO*
    pbCountersignature As IntPtr,   ' BYTE* optional, out
    ByRef pcbCountersignature As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwEncodingType : DWORD
' pbSignerInfo : BYTE*
' cbSignerInfo : DWORD
' cCountersigners : DWORD
' rgCountersigners : CMSG_SIGNER_ENCODE_INFO*
' pbCountersignature : BYTE* optional, out
' pcbCountersignature : DWORD* in/out
Declare PtrSafe Function CryptMsgCountersignEncoded Lib "crypt32" ( _
    ByVal dwEncodingType As Long, _
    ByVal pbSignerInfo As LongPtr, _
    ByVal cbSignerInfo As Long, _
    ByVal cCountersigners As Long, _
    ByVal rgCountersigners As LongPtr, _
    ByVal pbCountersignature As LongPtr, _
    ByRef pcbCountersignature As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptMsgCountersignEncoded = ctypes.windll.crypt32.CryptMsgCountersignEncoded
CryptMsgCountersignEncoded.restype = wintypes.BOOL
CryptMsgCountersignEncoded.argtypes = [
    wintypes.DWORD,  # dwEncodingType : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignerInfo : BYTE*
    wintypes.DWORD,  # cbSignerInfo : DWORD
    wintypes.DWORD,  # cCountersigners : DWORD
    ctypes.c_void_p,  # rgCountersigners : CMSG_SIGNER_ENCODE_INFO*
    ctypes.POINTER(ctypes.c_ubyte),  # pbCountersignature : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbCountersignature : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptMsgCountersignEncoded = Fiddle::Function.new(
  lib['CryptMsgCountersignEncoded'],
  [
    -Fiddle::TYPE_INT,  # dwEncodingType : DWORD
    Fiddle::TYPE_VOIDP,  # pbSignerInfo : BYTE*
    -Fiddle::TYPE_INT,  # cbSignerInfo : DWORD
    -Fiddle::TYPE_INT,  # cCountersigners : DWORD
    Fiddle::TYPE_VOIDP,  # rgCountersigners : CMSG_SIGNER_ENCODE_INFO*
    Fiddle::TYPE_VOIDP,  # pbCountersignature : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbCountersignature : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptMsgCountersignEncoded(
        dwEncodingType: u32,  // DWORD
        pbSignerInfo: *mut u8,  // BYTE*
        cbSignerInfo: u32,  // DWORD
        cCountersigners: u32,  // DWORD
        rgCountersigners: *mut CMSG_SIGNER_ENCODE_INFO,  // CMSG_SIGNER_ENCODE_INFO*
        pbCountersignature: *mut u8,  // BYTE* optional, out
        pcbCountersignature: *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 CryptMsgCountersignEncoded(uint dwEncodingType, IntPtr pbSignerInfo, uint cbSignerInfo, uint cCountersigners, IntPtr rgCountersigners, IntPtr pbCountersignature, ref uint pcbCountersignature);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptMsgCountersignEncoded' -Namespace Win32 -PassThru
# $api::CryptMsgCountersignEncoded(dwEncodingType, pbSignerInfo, cbSignerInfo, cCountersigners, rgCountersigners, pbCountersignature, pcbCountersignature)

#uselib "CRYPT32.dll"
#func global CryptMsgCountersignEncoded "CryptMsgCountersignEncoded" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptMsgCountersignEncoded dwEncodingType, varptr(pbSignerInfo), cbSignerInfo, cCountersigners, varptr(rgCountersigners), varptr(pbCountersignature), varptr(pcbCountersignature)   ; 戻り値は stat
; dwEncodingType : DWORD -> "sptr"
; pbSignerInfo : BYTE* -> "sptr"
; cbSignerInfo : DWORD -> "sptr"
; cCountersigners : DWORD -> "sptr"
; rgCountersigners : CMSG_SIGNER_ENCODE_INFO* -> "sptr"
; pbCountersignature : BYTE* optional, out -> "sptr"
; pcbCountersignature : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptMsgCountersignEncoded "CryptMsgCountersignEncoded" int, var, int, int, var, var, var
; res = CryptMsgCountersignEncoded(dwEncodingType, pbSignerInfo, cbSignerInfo, cCountersigners, rgCountersigners, pbCountersignature, pcbCountersignature)
; dwEncodingType : DWORD -> "int"
; pbSignerInfo : BYTE* -> "var"
; cbSignerInfo : DWORD -> "int"
; cCountersigners : DWORD -> "int"
; rgCountersigners : CMSG_SIGNER_ENCODE_INFO* -> "var"
; pbCountersignature : BYTE* optional, out -> "var"
; pcbCountersignature : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptMsgCountersignEncoded "CryptMsgCountersignEncoded" int, sptr, int, int, sptr, sptr, sptr
; res = CryptMsgCountersignEncoded(dwEncodingType, varptr(pbSignerInfo), cbSignerInfo, cCountersigners, varptr(rgCountersigners), varptr(pbCountersignature), varptr(pcbCountersignature))
; dwEncodingType : DWORD -> "int"
; pbSignerInfo : BYTE* -> "sptr"
; cbSignerInfo : DWORD -> "int"
; cCountersigners : DWORD -> "int"
; rgCountersigners : CMSG_SIGNER_ENCODE_INFO* -> "sptr"
; pbCountersignature : BYTE* optional, out -> "sptr"
; pcbCountersignature : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。